Git Product home page Git Product logo

blog-fastapi's Introduction

Blog FastAPI

Actions Status

This is a blog API with authentication, postings [CRUD], and the ability to vote on a post.

Installation

These instructions will get you a copy of the project up and running on your local machine.

  1. Git clone or download the project files.
git clone https://github.com/hazzillrodriguez/blog-fastapi.git && cd blog-fastapi
  1. Create and activate the virtual environment, then install the requirements.
python -m venv env
source env/Scripts/activate
pip install -r requirements.txt
  1. Create .env file and set the environment variables.
DB_USERNAME=your_db_username
DB_PASSWORD=your_db_password
DB_HOST=localhost
DB_PORT=5432
DB_NAME=name_of_your_database_here

SECRET_KEY=your_secret_key_here
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_MINUTES=60
  1. Start Postgres and create a database with the same name as your DB_NAME.

  2. Start the development server.

uvicorn app.main:app --reload

This project contains a Swagger UI.

To view this API's Swagger UI, run this application, then navigate to http://localhost:8000/docs.
You can test out this API entirely from the Swagger UI page.

Running the Tests

To run all the tests at once, use the command:

pytest -v

Contact

Hazzill Rodriguez — LinkedIn[email protected]

Acknowledgments

blog-fastapi's People

Contributors

hazzillrodriguez avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.