An open API service indexing awesome lists of open source software.

https://github.com/dekal/metaweather-forecast


https://github.com/dekal/metaweather-forecast

Last synced: over 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# metaweather-forecast

## System Design
Please take a look at [System Design](https://github.com/DeKal/metaweather-forecast/blob/master/system-design.pdf)

## Prerequisite
- Docker
- Docker compose

## Development
- Build docker images using (Only first time)
```
docker-compose build
```
- Running docker containers using
```
docker-compose up
```

## Production
- Build docker images using:
```
docker-compose -f docker-compose.production.yml build
```
- Running docker containers using:
```
docker-compose -f docker-compose.production.yml up
```

## Manually
In case your docker environment has something wrong, just start 2 project in 2 different terminal tabs. As default, client will run at http://localhost:3000 and backend service will run at http://localhost:3001.
- Start Client
```
cd day-weather-forecast
yarn instal
yarn start
```
- Start backend
```
cd weather-service
yarn instal
yarn start
```

## Frontend
### Documetation
- See [Front-end docs](/day-weather-forecast/README.md) for more development detail.
### Demo
- Visit http://localhost:3000 to see the page
1) Suggestion city

2) Show 6 days weather forecast
- Desktop

- Mobile

- Ipad

- Ipad pro

## Backend
### Documetation
- See [Back-end docs](/weather-service/README.md) for more development detail.
### Swagger
- Visit http://localhost:3001/docs to see the api contract