https://github.com/bernardodiasc/x-world-map
https://github.com/bernardodiasc/x-world-map
javascript map maps reactjs
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bernardodiasc/x-world-map
- Owner: bernardodiasc
- Created: 2021-11-22T11:52:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-20T16:09:01.000Z (about 2 years ago)
- Last Synced: 2023-04-19T06:47:01.378Z (about 2 years ago)
- Topics: javascript, map, maps, reactjs
- Language: TypeScript
- Homepage: http://x-world-map.com
- Size: 12.5 MB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# X-World-Map
World map to display people, events, travels and more.
- Website: [x-world-map.com](https://x-world-map.com/)
- Design System: [x-world-map.com/docs](https://x-world-map.com/docs/)
## Getting Started
First make copy of `.env.example` in the root of this project and use the name `.env.local`.
Then add the keys:
### X-World-Map API
```
NEXT_PUBLIC_API_URL=http://localhost:1337
```
The URL refers to the setup https://github.com/bernardodiasc/x-world-map-api
### Google Maps API
```
NEXT_PUBLIC_GMAPS_API_KEY
```
The Google Maps API key is required to appropriatedly load the map. In order to get the key you must create a new project at Google Cloud, then activate the **Maps Javascript API** and **Geocoding API** for this new project. It will require to add Billing details, but no worries, for development purposes it should stay below the charged range.
### Development
Install dependencies:
```bash
yarn install
```
Run the app:
> Make sure you have the [x-world-map-api](https://github.com/bernardodiasc/x-world-map-api) running also
```bash
yarn develop
```
#### Design System
```bash
yarn storybook
```