📓 Blog API

A Restful API for creating and managing a blog, powered by the FastAPI framework.

Features:

• ✅ Sign-up & Sign-in
• ✅ Create and Customize your profile
• [todo]

📚 Table of Contents

• Getting Started
• Commands
• Endpoints
• Tech Stack
• License
• Checklist

To know more about the project structure, check the structure.md file.

🤖 Getting Started

1. Clone the repository

git clone https://github.com/wesleybertipaglia/blog-api.git

2. Initialize and Activate the virtual environment

Make init
source venv/bin/activate

3. Install the dependencies and init the alembic

Make setup

4. Run the application

Make run

🚀 Open your browser and go to http://localhost:8000 to see the api in action.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
Make init	Initialize the virtual enviroment
source venv/bin/activate	Activate the virtual enviroment
Make setup	Install dependencies and init the alembic
Make freeze	Update the dependencies
Make run	Starts the application
Make alembic-revision	Make an alembic revision
Make alembic-upgrade	Make an alembic upgrade

To know more about the commands, check the commands.md file.

🪧 Endpoints

The API has the following endpoints:

• /auth: Sign-up and Sign-in
• /profile: Read, Update, Delete
• /users: Read
• /posts: Create, Read, Update, Delete

To know more about the endpoints, check the endpoints.md file, or access the API documentation in the following URL: localhost:8000/docs

🧩 Tech Stack

• Python
• FastAPI
• PostgreSQL and Adminer

To know more about the tech stack, check the stack.md file.

☑️ Cheklist

The following checklist can be used to track the project progress:

• Authentication
• Authorization
• Documentation
• Tests
• Docker
• CI/CD
• Deploy
• Monitoring

📜 License

This repository is licensed under the [MIT]. See the LICENSE file for details.

Back to top