Skip to content

tiagobpires/mini-feed

Repository files navigation

Mini Feed

REST API to manage users and posts

Status: ✔️ Available

AboutFeaturesTech StackInstallationUsageContact

About

Mini Feed is an API where you can do the basic operations (CRUD) in both users and posts table to a mini feed!

Features

  • users and posts CRUD
  • Auth by JWT Token
  • Add user image

Tech Stack

flask Badge  postgresql Badge  python Badge 

Installation

To Install this project, follow the steps above:

# Clone this repository
$ git clone https://github.com/tiagobpires/mini-feedgit
                        
# Create a virtual environment (optional but recommended):
$ python -m venv venv
                        
# Activating the virtual environment:
$ source venv/bin/activate
                        
# Install requirements:
$ pip install -r requirements.txt

Usage

  1. Create a ".env" file based on the template.
  2. Create the database:
# Set FLASK_APP variable (for windows)
set FLASK_APP="main.py"

# Create database
flask db init
flask db migrate
flask db upgrade
  1. Run the application:
# Running
python main.py

Contact

Made with ❤️ by Tiago Barros

LinkedIn Badge