franjsco
/
umbrello-api
mirror of https://github.com/franjsco/umbrello-api
1
0
Fork 0
Code Issues Releases Wiki Activity

Edit readme

This commit is contained in:
Francesco Esposito 2019-09-05 19:38:13 +02:00
parent b0c6d5d1ac
commit eab369ed34
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,6 +1,8 @@
# umbrello-api # umbrello-api
Rest API for umbrello-bot Rest API for umbrello-bot.
The weather information is based on [OpenWeatherMap API](https://openweathermap.org/api).
**Technologies**: **Technologies**:
@ -15,8 +17,9 @@ Rest API for umbrello-bot
3. Clone this repository. 3. Clone this repository.
4. Install dependencies with `npm install` 4. Install dependencies with `npm install`
5. Create env file or set environment variables. (read "Environment variables" paragraph) 5. Create env file or set environment variables. (read "Environment variables" paragraph)
6. Build with `npm run build`. 6. Configure the list of city id (read "OpenWeatherMap - List Of City ID")
7. Start the server with `npm run serve`. 7. Build with `npm run build`.
8. Start the server with `npm run serve`.
### Environment Variables. ### Environment Variables.
@ -32,6 +35,13 @@ DB_USER=user
DB_PASSWORD=password DB_PASSWORD=password
``` ```
### OpenWeatherMap - List Of City ID
1. Download [city.list.min.json.gz](http://bulk.openweathermap.org/sample/city.list.min.json.gz)
2. Extract the json.
3. Import the json into MongoDB (collection: `umbrello_cities`).
## License ## License
GPLv3 GPLv3