https://github.com/geffrerson7/projects-api
It is an API for creating personal portfolio projects.
https://github.com/geffrerson7/projects-api
docker flask flask-cors flask-smorest flask-sqlalchemy mysql python swagger
Last synced: 7 months ago
JSON representation
It is an API for creating personal portfolio projects.
- Host: GitHub
- URL: https://github.com/geffrerson7/projects-api
- Owner: Geffrerson7
- Created: 2023-05-18T23:17:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-17T23:41:32.000Z (almost 2 years ago)
- Last Synced: 2025-06-01T05:09:50.582Z (7 months ago)
- Topics: docker, flask, flask-cors, flask-smorest, flask-sqlalchemy, mysql, python, swagger
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PROJECTS-API
## Description
It is an API for creating personal portfolio projects.
## Local Installation
First clone the repository from Github and switch to the new directory:
```bash
$ clone git https://github.com/Geffrerson7/PROJECTS-API.git
```
```bash
$ cd PROJECTS-API
```
Activate the virtualenv for your project.
```sh
$ virtualenv venv
# windows
$ source venv/Scripts/activate
# Linux
$ source venv/bin/activate
```
Install project dependencies:
```sh
(env)$ pip install -r requirements.txt
```
Create the following environment variables in the .env file
`FLASK_APP`
`FLASK_DEBUG`
`FLASK_ENV`
`SECRET_KEY`
`SQLALCHEMY_DATABASE_URI`
Execute the migrations:
```sh
(env)$ flask db init
```
```sh
(env)$ flask db migrate
```
```sh
(env)$ flask db upgrade
```
You can now run the development server:
```sh
(env)$ flask run
```
And navigate to
```sh
http://127.0.0.1:5000/
```
## Project installation in Docker
Clone the repository
```bash
$ git clone https://github.com/Geffrerson7/PROJECTS-API.git
```
Go to the project directory.
```bash
$ cd PROJECTS-API
```
Run the command
```sh
$ docker-compose up
```
And navigate to the route
```sh
http://127.0.0.1:5000/
```
## Technologies and programming languages
* **Python** (v. 3.11.2) [Source](https://www.python.org/)
* **Flask** (v. 2.3.2) [Source](https://flask.palletsprojects.com/en/2.2.x/)
* **Flask-SQLAlchemy** (v. 3.0.3) [Source](https://flask-sqlalchemy.palletsprojects.com/en/3.0.x/quickstart/)
* **Flask-Cors** (v. 3.0.10) [Source](https://flask-cors.readthedocs.io/en/latest/)
* **flask-marshmallow** (v. 0.15.0) [Source](https://flask-marshmallow.readthedocs.io/en/latest/)
* **python-dotenv** (v. 1.0.0) [Source](https://pypi.org/project/python-dotenv/)
* **PyJWT** [Source](https://pyjwt.readthedocs.io/en/latest/)
* **flask-smorest** (v. 0.42.0) [Source](https://flask-smorest.readthedocs.io/en/latest/)
* **bcrypt** (v. 4.0.1) [Source](https://pypi.org/project/bcrypt/)
## API documentation
[Postman documentation link](https://documenter.getpostman.com/view/24256278/2s93m1aPui)
## Author
- [Gefferson Max Casasola Huamancusi](https://www.github.com/Geffrerson7)