https://github.com/yeukfei02/weatherapi

docker javascript mongodb nodejs openweathermap weather weatherapi

Last synced: 13 days ago
JSON representation

weatherApi by openweathermap

Host: GitHub
URL: https://github.com/yeukfei02/weatherapi
Owner: yeukfei02
License: mit
Created: 2020-03-10T06:11:17.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2023-12-15T17:40:01.000Z (about 2 years ago)
Last Synced: 2025-02-28T11:53:43.872Z (11 months ago)
Topics: docker, javascript, mongodb, nodejs, openweathermap, weather, weatherapi
Language: JavaScript
Homepage:
Size: 178 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

README

# weatherApi

[![codecov](https://codecov.io/gh/yeukfei02/weatherApi/branch/master/graph/badge.svg)](https://codecov.io/gh/yeukfei02/weatherApi)

weatherApi by openweathermap

documentation:

## Requirement

- install yarn
- install node (v12+)
- install mongodb

## Testing and run

```zsh
$ yarn

// development
$ yarn run dev

// production
$ yarn run start

// run test case
$ yarn run test

// use eslint and prettier to format code
$ yarn run lint
```

## Docker

```zsh
// build images and start container in one line
docker-compose up -d --build

// go inside container
docker exec -it /bin/bash

// check container logs
docker logs

// remove and stop container
docker-compose down
```

open localhost:3000

## Contributing

Please refer to [CONTRIBUTING.md](https://github.com/yeukfei02/weatherApi/blob/master/CONTRIBUTING.md)