|
1 |
| -<p align="center"><img width="40%" src="https://hacktoberfest.digitalocean.com/assets/logo-hf19-full-10f3c000cea930c76acc1dedc516ea7118b95353220869a3051848e45ff1d656.svg"/></p> |
| 1 | +# SimpleMath-Flask |
2 | 2 |
|
3 |
| -# Hacktoberfest, 2019 with IEEE-VIT Student Branch |
| 3 | +<img src="https://files.ieeevit.org/Hacktoberfest-23/Simple%20Math.png" alt="README Banner"/> |
4 | 4 |
|
5 |
| -SimpleMath-Flask is a Flask app that does math for you. This repository was created to help developers get started with Open Source during [Hacktoberfest](https://hacktoberfest.digitalocean.com/) |
| 5 | +# Hacktoberfest, 2023 with IEEE-VIT Student Branch |
| 6 | + |
| 7 | +SimpleMath-Flask is a Flask app that does math for you. This repository was created to help developers get started with Open Source during [Hacktoberfest](https://hacktoberfest.com/) |
6 | 8 | > NOTE: Check out `issues` labelled as `Hacktoberfest` and start contributing!
|
7 | 9 |
|
8 |
| -Made with :heart: by [IEEE-VIT](https://ieeevit.com) |
| 10 | +Made with :heart: by [IEEE-VIT](https://ieeevit.org/) |
9 | 11 |
|
10 |
| -Support Open Source by participating in [Hacktoberfest](https://hacktoberfest.digitalocean.com/) :yellow_heart: |
| 12 | +Support Open Source by participating in [Hacktoberfest](https://hacktoberfest.com/) :yellow_heart: |
11 | 13 |
|
12 | 14 | ## Getting started
|
13 | 15 |
|
14 |
| -1. To setup this project, simply run the following command: |
| 16 | +1.Before setting up the project,Create A virtual environment in the project directory using the following command: |
| 17 | +```bash |
| 18 | + python -m venv .venv |
| 19 | +``` |
| 20 | +2.The environment has been created just needs to be activated: |
| 21 | +`bash` |
| 22 | +For mac/linux users: `source .venv/bin/activate` |
| 23 | +For windows users: `source .venv/Scripts/activate` |
| 24 | + |
| 25 | + |
| 26 | +3. To setup this project, simply run the following command: |
15 | 27 | ```bash
|
16 |
| -$ pip3 install -r requirements.txt |
| 28 | + pip install -r requirements.txt |
17 | 29 | ```
|
18 | 30 |
|
19 | 31 | It should download and setup the dependencies and you're good to go! :)
|
20 | 32 |
|
21 |
| -2. All the routes are setup inside `routes/routes.py`. Most of your code should go there. |
| 33 | +4. All the routes are setup inside `routes/routes.py`. Most of your code should go there. |
22 | 34 |
|
23 |
| -3. To start the project, simply run the following command: |
| 35 | +5. To start the project, simply run the following command: |
24 | 36 | ```bash
|
25 |
| -$ python3 app.py |
| 37 | + python app.py |
26 | 38 | ```
|
27 | 39 |
|
28 |
| -4. All the unit tests are located inside `tests/test_app.py`. All the tests should go there. |
| 40 | +6. All the unit tests are located inside `test/test_app.py`. All the tests should go there. |
29 | 41 |
|
30 |
| -5. To run the test suite, execute the following command: |
| 42 | +7. To run the test suite, execute the following command: |
31 | 43 | ```bash
|
32 |
| -$ python3 tests/test_app.py |
| 44 | + python tests/test_app.py |
33 | 45 | ```
|
34 | 46 |
|
35 | 47 | ## Contributing
|
|
0 commit comments