README.md

A production ready dockerized express boilerplate to make your server-side development a breeze 🚀

---

⚡Features

✅ Production ready with one docker-compose command.
✅ Use MVC architecture.
✅ Local dockerized postgres db.
✅ Dockerized PgAdmin to check the db records.
✅ Sequelize ORM configured.
✅ CRUD API (Todo App).
✅ JEST for testing.
✅ Seperate Database(Sqlite) configured for test cases coverage.
✅ Hot Container reload.

⚒️ Techologies Used

• Sequelize: For ORM & database operations.
• JEST: For testing purposes.
• Docker & docker-compose : For Virtualization.
• postgresSQL: Database.
• PgAdmin: To interact with the Postgres database sessions.
• Swagger-Autogen: To automatically generate swagger-ui documentation.

💥 Setup & Usage

Make sure you have docker and docker-compose installed docker installation guide

Step 1

create .env file in the root directory

DATABASE_URL=postgres://postgres:postgres@database:5432/todo-app-db
DB_USER=postgres
DB_PASSWORD=postgres
DB_NAME=todo-app-db
[email protected]
PGADMIN_PASSWORD=password

Step 2

docker-compose build

Step 3

docker-compose up

🔍 Preview

Your Production Ready Express CRUD backend app is up and running on localhost:3000 🎉

• Swagger docs on localhost:3000/api/docs

• PgAdmin on localhost:7000

👨🏻‍💻 Contributing

Make sure you read the contributing guidelines before opening a PR.

🔑 License

• MIT © Meer Hamza

⚡ AUTHOR

🙋🏻‍♂️ Yo! It's Meer, a senior year CS undergrad. Let's get connected