Twitter API

This is a project for Platzi's FastAPI course.

Table of Contents:

• Twitter API
• Table of Contents:
• Description
• Features
• Tech Stack
• Installation
• Run it locally
• Documentation
• Contributing
• Authors
• License

Description

Twitter REST API made with FastAPI for learning purposes.

Features

• User signup and login.
• JSON Web Tokens Authentication.
• FastAPI Routers.
• SQLite3 conecction with SQLAlchemy.
• SQLAlchemy models.
• Data validation.
• Users CRUD operations.
• Tweets CRUD operations
• Pydantic models.

Tech Stack

• FastAPI, Python 3.10, SQLite3, SQLAlchemy

Installation

1. Clone or download the repository:

git clone https://github.com/betofleitass/twitter-fast-api

2. Go to the project directory

cd twitter-fast-api

2. Create a virtual environment (PowerShell):

 python -m venv venv
 venv\Scripts\Activate.ps1

3. Install dependencies:

pip install -r requirements.txt

Run it locally

1. Go to the app directory: cd app

2. Change the env.example file name to .env, pay atenttion to the dot before env.

3. Run the server: uvicorn main:app --reload

4. Open a browser and go to: http://127.0.0.1:8000/

Documentation

Once the server is running go to http://localhost:8000/docs to view the API documentation.

Contributing

Contributions are always welcome!

• Fork this repository;

• Create a branch with your feature: git checkout -b my-feature;

• Commit your changes: git commit -m "feat: my new feature";

• Push to your branch: git push origin my-feature.

Authors

• @betofleitass

License

This project is under MIT License.

Back to top ⬆️