fastapi_mongodb_server

Template for a simple python FastAPI connecting to mongodb

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

This is a blank template for a Python based asynchronous API. This project makes use of FastAPI, Pydantc and includes Motor as an asynchronous Python driver for MongoDB.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Some basic installation and setup details can be found below.

Prerequisites

I'd recommend using Poetry to manage the dependecy installation/ virtual environment setup.

• Poetry

  curl -sSL https://install.python-poetry.org | python3 -

• MongoDB
  See the the download page or the docker image

Installation

1. Clone the repo

   git clone https://github.com/AwfulMoo/fastapi_mongodb_server.git

2. Install Python packages (from inside the cloned repo)

   poetry install

3. Select the Python intpreter (use the path to the poetry virtual env created in the last step)

   poetry install

4. Update the config.py file to include database connection settings as needed

(back to top)

Usage

You can debug the application by pressing F5 in Visual Studio Code

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Make your changes
4. Stage your changes (git add yourChangedFile.filetype)
5. Commit your changes (git commit -m 'Added an AmazingFeature!')
6. Push to the branch (git push origin feature/AmazingFeature)
7. Open a pull request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/AwfulMoo/fastapi_mongodb_server

(back to top)

Acknowledgments

• Best-README-Template

(back to top)