polished readme

This commit is contained in:
Jordan Yamada
2024-05-19 18:13:21 +00:00
parent 89bd33afc6
commit 501f5cbf61
5 changed files with 28 additions and 19 deletions

View File

@@ -12,12 +12,13 @@ Deep Impact is a web application designed to provide users with insights into th
### Our Team ### Our Team
- Daniel Smith-dePaz - [Pierre Bell](https://github.com/Landy-87)
- Jordan Yamada - [Jordan Edgington](https://github.com/Jordan-Edgington)
- Pierre Bell - [Michael Roy](https://github.com/its-michaelroy)
- Michael Roy - [Mickey Shoenberger](https://github.com/michelle-shoenberger)
- Mickey Shoenberger - [Daniel Smith-dePaz](https://github.com/adeadzeplin)
- Jordan Edgington - [Jordan Yamada](https://github.com/JordanYamada)
To learn more about Deep Impact, check out our [Deep Impact GitHub](https://github.com/Team-Deep-Impact/Deep-Impact). To learn more about Deep Impact, check out our [Deep Impact GitHub](https://github.com/Team-Deep-Impact/Deep-Impact).
@@ -28,6 +29,10 @@ To learn more about Deep Impact, check out our [Deep Impact GitHub](https://gith
3. **Simulation Tool**: Simulate asteroid trajectories and deflection outcomes. 3. **Simulation Tool**: Simulate asteroid trajectories and deflection outcomes.
4. **Dashboard**: View the dashboard, and other pages with relevant information and insights. 4. **Dashboard**: View the dashboard, and other pages with relevant information and insights.
## Technical Documentations
[Frontend Documentaions](./frontend/README.md)
## Getting Started ## Getting Started
### Django Backend Setup ### Django Backend Setup
@@ -60,7 +65,14 @@ To learn more about Deep Impact, check out our [Deep Impact GitHub](https://gith
python manage.py migrate python manage.py migrate
``` ```
4. **Start Django Server**: 4. **Making Environmental Variables**:
- Ensure you're located in the path: Deep-Impact/backend
```sh
touch .env
```
- Follow the .env.sample as a template to fill in your environmental variables
5. **Start Django Server**:
- Ensure you're located in the path: Deep-Impact/backend - Ensure you're located in the path: Deep-Impact/backend
```sh ```sh
python manage.py runserver python manage.py runserver
@@ -74,7 +86,14 @@ To learn more about Deep Impact, check out our [Deep Impact GitHub](https://gith
npm install npm install
``` ```
2. **Run Development Server**: 2. **Making Environmental Variables**:
- Ensure you're located in the path: Deep-Impact/frontend
```sh
touch .env
```
- Follow the .env.sample as a template to fill in your environmental variables
3. **Run Development Server**:
- Start the development server: - Start the development server:
```sh ```sh
npm run dev npm run dev

View File

@@ -72,16 +72,6 @@ const Effects = () => {
</li> </li>
</ul> </ul>
<h3 className="text-2xl font-bold text-white my-5">Mitigation and Prevention</h3>
<ul className="list-disc pl-5 text-l text-white">
<li className="mb-3">
<strong>Early Detection:</strong> Advances in space observation aim to detect potential impactors well in advance. Programs like NASAs Near-Earth Object (NEO) Observations Program work towards this goal.
</li>
<li className="mb-3">
<strong>Deflection Strategies:</strong> Potential strategies for deflecting an asteroid include kinetic impactors, gravitational tractors, or even nuclear devices to alter the asteroids trajectory.
</li>
</ul>
<div className="mt-3"> <div className="mt-3">
<p className="text-l text-white mb-10"> <p className="text-l text-white mb-10">
In summary, while the impact of small meteors is relatively minor and localized, large meteors can have devastating global consequences. Preparedness and mitigation strategies are essential for minimizing the potential impacts of such events. In summary, while the impact of small meteors is relatively minor and localized, large meteors can have devastating global consequences. Preparedness and mitigation strategies are essential for minimizing the potential impacts of such events.
@@ -91,4 +81,4 @@ const Effects = () => {
); );
} }
export default Effects; export default Effects