Skip to content

Commit ea2fa92

Browse files
authored
Update README.md
1 parent 9ed7b81 commit ea2fa92

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
1-
# Flask-RestAPI-SQLAlchemy-Project
1+
# Flask RestAPI Project
2+
It is a RESTful API-based web app that utilizes SQLAlchemy and Flask Marshmallow to enable seamless product management operations, including creation, reading, updating, and deletion of product records in a database.
3+
```bash
4+
Key Features
5+
1. Used Flask, SQLAlchemy, Marshmallow, RestAPI
6+
2. Allowed RestAPI operations
7+
1. Display all products
8+
2. Add a product
9+
3. Get a product
10+
4. Edit a product
11+
5. Delete a product
12+
13+
```
14+
15+
## How to Install this app
16+
17+
```python
18+
#create a virtual environment
19+
python3 -m venv env
20+
21+
#install required modules
22+
pip install -r requirements.txt
23+
24+
# Or install Flask and sqlalchemy
25+
pip install flask Flask-SQLAlchemy
26+
pip install flask-marshmallow marshmallow-sqlalchemy
27+
28+
```
29+
30+
## Contributing
31+
32+
Pull requests are welcome. For major changes, please open an issue first
33+
to discuss what you would like to change.
34+
35+
Please make sure to update tests as appropriate.
36+
37+
## SnapShot
38+
39+
![image](https://github.com/vickytilotia/Flask-RestAPI-SQLAlchemy-Project/assets/32337899/0622dbc7-f655-4159-b587-8658d385e8d6)

0 commit comments

Comments
 (0)