Skip to content

Commit 013b07c

Browse files
necessary updates (#103)
* necessary updates * requested changes * Requested Updates #2 * Banner update * Update * update * 3 removed
1 parent 86e2237 commit 013b07c

File tree

4 files changed

+38
-26
lines changed

4 files changed

+38
-26
lines changed

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
/__pycache__
2-
/routes/__pycache__
2+
/routes/__pycache__
3+
/.venv

README.md

+25-13
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,47 @@
1-
<p align="center"><img width="40%" src="https://hacktoberfest.digitalocean.com/assets/logo-hf19-full-10f3c000cea930c76acc1dedc516ea7118b95353220869a3051848e45ff1d656.svg"/></p>
1+
# SimpleMath-Flask
22

3-
# Hacktoberfest, 2019 with IEEE-VIT Student Branch
3+
<img src="https://files.ieeevit.org/Hacktoberfest-23/Simple%20Math.png" alt="README Banner"/>
44

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/)
68
> NOTE: Check out `issues` labelled as `Hacktoberfest` and start contributing!
79
8-
Made with :heart: by [IEEE-VIT](https://ieeevit.com)
10+
Made with :heart: by [IEEE-VIT](https://ieeevit.org/)
911

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:
1113

1214
## Getting started
1315

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:
1527
```bash
16-
$ pip3 install -r requirements.txt
28+
pip install -r requirements.txt
1729
```
1830

1931
It should download and setup the dependencies and you're good to go! :)
2032

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.
2234

23-
3. To start the project, simply run the following command:
35+
5. To start the project, simply run the following command:
2436
```bash
25-
$ python3 app.py
37+
python app.py
2638
```
2739

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.
2941

30-
5. To run the test suite, execute the following command:
42+
7. To run the test suite, execute the following command:
3143
```bash
32-
$ python3 tests/test_app.py
44+
python tests/test_app.py
3345
```
3446

3547
## Contributing

routes/routes.py

+9-12
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,17 @@
66
def check():
77
return "Congratulations! Your app works. :)"
88

9-
109
@router.route("/add", methods=["POST"])
1110
def add():
1211
# Add logic here
13-
return
14-
x = request.form.data.param1
15-
y = request.form.data.param2
12+
return
1613

17-
summation = x+y
14+
@router.route("multiply",methods=["POST"])
15+
def multiply():
16+
#Add logic here
17+
return
1818

19-
res = {
20-
result: summation,
21-
meta: {
22-
message: "sending addition of two numbers"
23-
}
24-
}
25-
return res
19+
@router.route("/division",methods=['POST'])
20+
def division():
21+
#Add logic here
22+
return

test/test_app.py

+2
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,7 @@ def test_check(self):
1818
response = self.app.get('/math/check')
1919
self.assertEqual(response.data, b'Congratulations! Your app works. :)')
2020

21+
#Add the test_cases for various functionality here
22+
2123
if __name__ == '__main__':
2224
unittest.main()

0 commit comments

Comments
 (0)