From 501f5cbf610c1a1e9f092b1500cf58c5cb0a5072 Mon Sep 17 00:00:00 2001 From: Jordan Yamada Date: Sun, 19 May 2024 18:13:21 +0000 Subject: [PATCH] polished readme --- README.md | 35 ++++++++++++++---- .../api_app/__pycache__/utils.cpython-311.pyc | Bin 11181 -> 11181 bytes .../api_app/__pycache__/views.cpython-311.pyc | Bin 1656 -> 1656 bytes .../__pycache__/settings.cpython-311.pyc | Bin 3121 -> 3121 bytes frontend/src/pages/effects.jsx | 12 +----- 5 files changed, 28 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 39f31e6..01ab202 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,13 @@ Deep Impact is a web application designed to provide users with insights into th ### Our Team -- Daniel Smith-dePaz -- Jordan Yamada -- Pierre Bell -- Michael Roy -- Mickey Shoenberger -- Jordan Edgington +- [Pierre Bell](https://github.com/Landy-87) +- [Jordan Edgington](https://github.com/Jordan-Edgington) +- [Michael Roy](https://github.com/its-michaelroy) +- [Mickey Shoenberger](https://github.com/michelle-shoenberger) +- [Daniel Smith-dePaz](https://github.com/adeadzeplin) +- [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). @@ -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. 4. **Dashboard**: View the dashboard, and other pages with relevant information and insights. +## Technical Documentations + +[Frontend Documentaions](./frontend/README.md) + ## Getting Started ### 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 ``` -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 ```sh python manage.py runserver @@ -74,7 +86,14 @@ To learn more about Deep Impact, check out our [Deep Impact GitHub](https://gith 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: ```sh npm run dev diff --git a/backend/api_app/__pycache__/utils.cpython-311.pyc b/backend/api_app/__pycache__/utils.cpython-311.pyc index b6d9dac2f0b0b016bc081dee1738a69c530adc1d..ae5f17dc0d0dd8478b2542d3a9aee9f8f516e396 100644 GIT binary patch delta 19 ZcmZ1*zBZg|IWI340}%AsY~)(34FEVN1up;q delta 19 ZcmZ1*zBZg|IWI340}x2_Zsc054FEKj1djj! diff --git a/backend/api_app/__pycache__/views.cpython-311.pyc b/backend/api_app/__pycache__/views.cpython-311.pyc index 0d710263829d9cc7104bd998c62954b821e18db5..5b62f7363eef6177f6af8f71a06ac91704ee9e64 100644 GIT binary patch delta 19 Zcmeyt^Mi+LIWI340}%AsY~;#g0{}QK1l0fl delta 19 Zcmeyt^Mi+LIWI340}!zBZsf{i0{}E11Rwwa diff --git a/backend/deep_impact_proj/__pycache__/settings.cpython-311.pyc b/backend/deep_impact_proj/__pycache__/settings.cpython-311.pyc index cbba63faba6b646e12b15e7b2df9c8672e2d2be2..39de91e9ffd2baa743779a17531bd4ac5d66e5d9 100644 GIT binary patch delta 19 Zcmdleu~C9+IWI340}%AsY~)hs0RS&T1RekY delta 19 Zcmdleu~C9+IWI340}$-x+{mTQ0{|~+1RMYW diff --git a/frontend/src/pages/effects.jsx b/frontend/src/pages/effects.jsx index ee6d4e1..8457c72 100644 --- a/frontend/src/pages/effects.jsx +++ b/frontend/src/pages/effects.jsx @@ -72,16 +72,6 @@ const Effects = () => { -

Mitigation and Prevention

- -

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