Skip to content

alpha037/atlas-weather-app

Repository files navigation

Atlas Weather-App

A minimalist asynchronous weather application.

Help:

You can use this web app to find out the weather of any place in real time. Just type in the name of the place in the search bar and see the magic happen.

Features include:

  • Complete location of the searched place.
  • Local time of the place, Date and the present weather forecast in that region.
  • Autocomplete feature powered by Google Places API (sometimes it won't work due to API traffic or daily API calls limit or a number of other reasons) and Weather based real-time icons (if available).

Docker Instructions

If you haven't installed Docker already, then you can get it from here. After installing it, create an account in Docker and copy the username.

Before running this application in docker, make sure to replace the API KEYS placeholder with your own.

This application is already dockerized. You can pull the image directly from docker hub:

docker pull alpha037/atlas-weather-app

OR

You can create your own by following the given steps.

To run the app as a docker container, follow the given steps:

  • Navigate to the project directory
    cd atlas-weather-app
  • Replace USERNAME with your own username and build the docker image
    docker build -t <USERNAME>/atlas-weather-app:1.0 .
  • Open up the terminal at the project directory, replace USERNAME with your own username and run the following command:
    docker run -p 3000:3000 <USERNAME>/atlas-weather-app:1.0
  • You can also use docker compose to manage your containers:
    docker-compose up
    and
    docker-compose down

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. For more details, check out the contributing guidelines.

  1. Fork the Project.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
  3. Commit your Changes (git commit -m 'Add some AmazingFeature').
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request.

License

Distributed under GNU AGPL 3.0. See LICENSE for more information.

Contact

Shubhranil Dutta - contact@shubhranil.com

Project Link: https://github.com/alpha037/atlas-weather-app