https://github.com/jefferson10147/unet-api
Flask API with MongoDB and JWT.
https://github.com/jefferson10147/unet-api
flask-api jwt mongodb python3 unet
Last synced: about 1 month ago
JSON representation
Flask API with MongoDB and JWT.
- Host: GitHub
- URL: https://github.com/jefferson10147/unet-api
- Owner: jefferson10147
- License: gpl-3.0
- Created: 2021-02-04T01:32:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-17T01:59:36.000Z (about 5 years ago)
- Last Synced: 2025-02-15T08:30:55.076Z (over 1 year ago)
- Topics: flask-api, jwt, mongodb, python3, unet
- Language: Python
- Homepage:
- Size: 61.5 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flask REST API with MongoDB
This is a REST API using python's microframework Flask, and NoSQL database MongoDB with Its mongo Atlas cloud manager. This API provides information of students at UNET, you can also make others CRUD operations like INSERT, PUT, or DELETE, but yow need to create an user and login to use JWT, to more information about this contact repo owner.
## To run this API on your local machine
1- Clone this project, on your local machine:
```bash
$ git clone https://github.com/jefferson10147/unet-api.git
```
2- Create a virtual env inside the folder:
```bash
$ python3 -m venv your_venv
```
3- Activate env:
```bash
$ source your_venv/bin/activate
```
4- Install dependencies:
```bash
$ pip install -r requirements.txt
```
5- Create and export variables to .flaskenv file:
```bash
$ touch .flaskenv
$ echo "FLASK_APP=main.py" > .flaskenv
```
Also you can export another variables to put aplication into development mode:
```bash
$ echo "FLASK_ENV=development" >> .flaskenv
```
6- Create an .env file with these variables
```
secret_key=your_app_secret_key
jwt_secret_key=your_jwt_secret_key
admin_key=your_admin_key
username_from_db=your_mongoDB_username
password_from_db=your_mongoDB_password
database_name=your_mongoDB_database
```
7- Run your app:
```bash
$ flask run
```
If you are using a local mongo database, you need to edit this variable at app.settings.py:
```python
MONGO_URI = YOUR_MONGO_URI
```
You can check all endpoints when you are running this API on your local machine: [DOCS](https://documenter.getpostman.com/view/8771822/TW77fNue)
## API online
There is an online version of this API currently running at Heroku cloud. Visit [Home page](https://unet-api.herokuapp.com). You can try all search endpoints, but not Insert, Update, and Delete operations. See online documentation at [DOC](https://documenter.getpostman.com/view/8771822/TWDUoxJ2#ac0a8fec-3882-40c9-b923-39e8509137fc)