This is a blog platform built using the FastAPI framework, which provides a simple and efficient way to create web APIs with Python. The platform includes token-based authentication to secure the API endpoints, ensuring that only authorized users can access the resources.
- FastAPI Framework: Built using FastAPI, a modern, fast (high-performance), web framework for building APIs with Python 3.7+ based on standard Python type hints.
- Token-based Authentication: Implements token-based authentication to secure the API endpoints, ensuring that only authorized users can access the resources.
- User Management: Provides user management functionalities such as user registration, login, and password reset.
- Blog Creation and Management: Allows users to create, read, update, and delete blog posts. Users can also add tags to their blog posts for better categorization.
- Comments and Likes: Users can comment on blog posts and like them to show their appreciation.
- Search Functionality: Includes a search functionality to search for blog posts based on keywords or tags.
- Pagination: Implements pagination for better performance and usability when dealing with large amounts of data.
- Database Support: Utilizes a database (e.g., PostgreSQL, MySQL, SQLite) to store blog posts, user information, comments, and likes.
To run this project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/abinashbordoloi/Blog_Platform-using-FastAPI.git
To run this project locally, follow these steps:
-
Navigate to the project directory:
cd Blog_Platform-using-FastAPI -
Create and activate a virtual environment (optional but recommended): python3 -m venv env
source env/bin/activate -
Install the required dependencies:
pip install -r requirements.txt
-
Configure the database settings in the config.py file.
-
Configure the database settings in the config.py file.
alembic upgrade head
-
Start the development server
uvicorn main:app --reload
The blog platform should now be accessible at http://localhost:8000.
The API documentation is automatically generated and provided by FastAPI. Once the development server is running, you can access the documentation at http://localhost:8000/docs in your web browser.
Please refer the CONTRIBUTION.md file for more detail or steps.
Please ensure that your code follows the project's coding style and that appropriate tests are included.
This project is licensed under the MIT License. See the LICENSE file for more information.
For any inquiries or questions, you can reach out to the project maintainer:
- Abinash Bordoloi
- GitHub: abinashbordoloi(https://github.com/abinashbordoloi)
- Email:emailme(mailto:iteratex.pseudocode@gmail.com)