README.md

FastAPI + ODMantic codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Getting Started

🔨 Installation

• Install Docker (necessary to run a local MongoDB instance)
• Make sure Python 3.10 is available on your system
• Install poetry
• Setup the environment ./scripts/setup.sh

💡 Useful scripts

• Start the MongoDB instance ./scripts/start-mongo.sh
• Stop the MongoDB instance ./scripts/stop-mongo.sh
• Start the FastAPI server ./scripts/start.sh
• Format the code ./scripts/format.sh
• Manually run the linter ./scripts/lint.sh
• Manually run the tests ./scripts/test.sh

Coming Soon

• Articles with details on every single step required to build this app
• Testing
• Deployment on AWS with MongoDB Atlas