Astro Dodge is a web application that tracks Near Earth Objects (NEOs) using NASA's Open APIs. It allows users to create an account, track specific objects on a watchlist, and and learn more details about a specific object.
- Copy this repository and run the command:
docker compose up - This will build the images necessary to run this project.
A ready to use Docker image should be hosted in the GitHub Packages Container Registry.
- Simply pull the image from this repository with:
docker pull ghcr.io/kev-odin/astro-dodge:latest - Run the image with this command:
docker run astro-dodge:latest - Then open your web browser and enter
localhost:5000in the address bar.
If you don't have Docker installed, you can follow these steps to install and run the Astro Dodge web application:
- Clone the repository:
git clone https://github.com/kev-odin/astro-dodge.git - Install dependencies using Poetry:
poetry install - Start the development server:
poetry run flask run
This will start the Astro Dodge web application and it will be accessible at http://localhost:5000/.
Astro Dodge is designed to be mobile-friendly, with responsive design that ensures the application looks great and functions well on any device.
Astro Dodge uses GitHub Actions for Continuous Integration and Continuous Deployment. When code is pushed to the main branch, GitHub Actions automatically runs the tests and builds a Docker image that is stored in the GitHub Container Registry.
If you are intrested in contributing to this project, feel free to create an issue, fork the repository, and create a pull request. If new features are added, write relevant unit and integration tests to ensure code coverage.
To run tests, you will need poetry installed. Learn more about the installation process .
Run this command: poetry run pytest
Astro Dodge is licensed under the MIT License.