Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue-47 feature request for app documentation #48

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Philippines Travel Level Map

## How to use the App

Mark the places you've visited and see which other more you wanna go to!

[Demo](https://my-philippines-travel-level.com/map)
Expand All @@ -14,3 +16,58 @@ Mark the places you've visited and see which other more you wanna go to!
| 5 | Lived there |

![phMap](https://user-images.githubusercontent.com/8638243/232649713-3ca6430d-2163-477c-aa05-bd79a530fafd.jpg)

## Installation and Development

### Installing the dependencies

```
## installation with yarn
yarn

## installation with npm
npm install
```

### Linting the files

```
## linting the files with yarn
yarn lint

## linting the files with npm
npm run lint
```


### Starting the Application

```
## starting the application with yarn
yarn start

## starting the application with npm
npm start
```
The application should automatically open in the localhost server at: https://localhost:3000

### Building the App for Production

```
## build the app with yarn
yarn build

## build the app with npm
npm run build

## serving with a static server
serve -s build
```
The localhost server can be opened at: https://localhost:3000


## Contributing Guide

Fork the repository, integrate your fixes, and make a pull request!

The full contributing guide can be found [here.](https://github.com/OSSPhilippines/philippines-travel-level-map/blob/main/CONTRIBUTING.md)
2 changes: 1 addition & 1 deletion src/pages/Map.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ const PhilippinesMap = () => {
localStorage.setItem('provinceLevels', JSON.stringify(clonePrevLevels));

return clonePrevLevels;
});
});

setMenuVisible(false);
},
Expand Down