Skip to content

API with the basic functionalities of twitter using FastApi, PostgreSQL and Docker

Notifications You must be signed in to change notification settings

camicontr/twitter-api-fastapi

Repository files navigation

Twitter-Api

Introduction

This application is the final project of the Curso de FastAPI: Modularización, Datos Avanzados y Errores course of platzi. This app adds to the tweet updates feature. The user and tweet data is stored in a PostgreSQL database, it also has validations and restrictions.

Depedencies

Dependencies for Docker:

Installation

Clone the repository

First you need to clone the repository.

git clone https://github.com/camicontr/twitter-api-fastapi.git

Docker Installation

To install twitter-api-fastapi on a docker container, run the following command:

docker compose --env-file .env up

Usage

Running the API

To run the API in the Docker container, run the following command:

Configure the server in pgadmin

  1. Go into pgadmin localhost:80, with user: admin@admin.com and password: admin
  2. Register a new server with name: DockerConnect, hostname: db, user and password: postgres
  3. Use
docker start twitter-api-fastapi_app

At this moment the app can already connect to the database

  1. Go into
http://localhost:8000/docs

here you will find all the documentation and you can use the api.

About

API with the basic functionalities of twitter using FastApi, PostgreSQL and Docker

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published