Update README.md

Updated Readme
This commit is contained in:
Michael Roy
2024-05-18 22:48:08 -04:00
committed by GitHub
parent 0de0b25fab
commit fc33f5e0f6

View File

@@ -1,3 +1,70 @@
# Deep Impact # Deep Impact
![Deep Impace](https://dalle-image-storage.s3.amazonaws.com/1715997915066.jpeg) ![Deep Impact](https://dalle-image-storage.s3.amazonaws.com/1715997915066.jpeg)
## Overview
Deep Impact is a web application designed to provide users with insights into the potential dangers of asteroid impacts. Utilizing the NASA NeoWs API, we've developed a simulation tool that visualizes incoming asteroids and explores various methods of asteroid deflection.
### Our Team
- Daniel Smith-dePaz
- Jordan Yamada
- Pierre Bell
- Michael Roy
- Mickey Shoenberger
- Jordan Edgington
To learn more about Deep Impact, check out our [Deep Impact GitHub](https://github.com/Team-Deep-Impact/Deep-Impact).
## Features
1. **Asteroid Visualization**: Visualize incoming asteroids using real-time data from the NASA NeoWs API.
2. **Scenario & Deflection Strategies**: Explore various methods of asteroid deflection, such as Nuclear Detonation, Kinetic Impact, and Gravity Tractor.
3. **Simulation Tool**: Simulate asteroid trajectories and deflection outcomes.
4. **Dashboard**: View the dashboard, and other pages with relevant information and insights.
## Getting Started
### Django Backend Setup
1. **Set Up Python Environment**:
- Vanilla Python:
```sh
python -m venv deep-impact-env
```
- Virtual Environment Wrapper:
```sh
mkvirtualenv deep-impact-env
```
- Activate the environment:
```sh
source deep-impact-env/bin/activate
```
2. **Install Required Packages**:
- Navigate to the backend directory and install dependencies:
```sh
cd Deep-Impact/backend/deep_impact_proj
pip install -r requirements.txt
```
### Vite Frontend Setup
1. **Install Node Modules**:
- Navigate to the frontend directory and install dependencies:
```sh
npm install
```
2. **Run Development Server**:
- Start the development server:
```sh
npm run dev
```
## License
Deep Impact is open-source software released under the [MIT License](LICENSE). Feel free to use, modify, and distribute the codebase in accordance with the terms of the license.
Thank you for choosing Deep Impact. We hope you enjoy exploring our project and learning more about asteroid impacts!