Skip to content

πŸ“πŸ”— Todo RESTful API: A fast and modern API built with FastAPI and Python for managing tasks, using Firebase, MongoDB, and PostgreSQL as data storage.

License

Notifications You must be signed in to change notification settings

ab3masta/todo_restfull_api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

27 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ Todo RESTful API

This is a RESTful API for managing tasks, built with FastAPI and Python. The project uses Firebase, MongoDB, and PostgreSQL to store tasks.

πŸš€ Quick Start

  1. Clone this repository.

  2. Install the dependencies with pip install -r requirements.txt.

  3. Create a .env file 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
    
  4. Start the server with uvicorn app.main:app.

  5. Open your browser and go to http://localhost:8000/docs to access the API documentation. The username:[email protected] and password:123456789 for authentication.

πŸ› οΈ Technologies

  • 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.

πŸ“„ API Documentation

You can find the API documentation in the Swagger UI by accessing the following URL: http://localhost:8000/docs.

πŸ‘¨β€πŸ’» Development

To contribute to this project, please follow these steps:

  1. Fork this repository.
  2. Create a new branch with your changes: git checkout -b my-feature.
  3. Commit your changes: git commit -m 'feat: add new feature'.
  4. Push to the branch: git push origin my-feature.
  5. Create a pull request.

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

About

πŸ“πŸ”— Todo RESTful API: A fast and modern API built with FastAPI and Python for managing tasks, using Firebase, MongoDB, and PostgreSQL as data storage.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published