This is a RESTful API for managing tasks, built with FastAPI and Python. The project uses Firebase, MongoDB, and PostgreSQL to store tasks.
-
Clone this repository.
-
Install the dependencies with
pip install -r requirements.txt. -
Create a
.envfile with your Firebase credentials, MongoDB URI, and PostgreSQL URI. Example:# FIREBASE FIREBASE_API_KEY=your-api-key FIREBASE_AUTH_DOMAIN=your-auth-domain FIREBASE_DATABASE_URL=your-database-url FIREBASE_PROJECT_ID=your-project-id FIREBASE_STORAGE_BUCKET=your-storage-bucket FIREBASE_MESSAGING_SENDER_ID=your-messaging-sender-id FIREBASE_APP_ID=your-app-id FIREBASE_MEASUREMENT_ID=your-measurement-id # MongoDB MONGO_URI=mongodb://localhost:27017/task # POSTGRESQl POSTGRES_URI=postgresql://user:password@localhost:5432/task -
Start the server with
uvicorn app.main:app. -
Open your browser and go to
http://localhost:8000/docsto access the API documentation. Theusername:admin@gmail.comandpassword:123456789for authentication.
- FastAPI: a modern, fast (high-performance) web framework for building APIs with Python 3.6+ based on standard Python type hints.
- Python: a high-level programming language for general-purpose programming.
- Firebase: a mobile and web application development platform developed by Firebase, Inc. in 2011, then acquired by Google in 2014.
- MongoDB: a general purpose, document-based, distributed database built for modern application developers and for the cloud era.
- PostgreSQL: a powerful, open source object-relational database system.
You can find the API documentation in the Swagger UI by accessing the following URL: http://localhost:8000/docs.
To contribute to this project, please follow these steps:
- Fork this repository.
- Create a new branch with your changes:
git checkout -b my-feature. - Commit your changes:
git commit -m 'feat: add new feature'. - Push to the branch:
git push origin my-feature. - Create a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.