CodeCrafters_be is the backend solution for the CodeCrafters project, which enables users to efficiently manage their own delivery company. This API handles order management, route optimization, and real-time user tracking, with a focus on providing scalable and reliable solutions for delivery operations.
- User Management: Secure and efficient user authentication and role-based access control (Admin, Driver, Customer).
- Order Management: Create, track, and update orders with real-time status changes.
- Route Optimization: Efficient routing algorithms to minimize delivery times and fuel costs.
- Real-Time Notifications: Keep drivers and customers informed with automated email notifications.
- Database Integration: Seamless data persistence with PostgreSQL.
- NestJS: A progressive Node.js framework for building efficient, scalable server-side applications.
- MySQL: A relational database for storing user and order data.
- TypeScript: Strongly typed JavaScript for building more reliable and maintainable code.
- Docker: Containerization for consistent development and production environments.
- JWT: JSON Web Token for secure authentication and authorization.
Ensure that you have the following installed:
-
Clone the repository:
git clone https://github.com/ZenBit-Tech/CodeCrafters_be.git cd CodeCrafters_be -
Create a .env file from the provided .env.example:
cp .env.example .env
-
Install dependencies:
npm install
-
Start the DB with Docker:
docker-compose up
-
Run database migrations:
npm run seed:superadmin npm run seed:general
-
Start the application in development mode:
npm run start:dev
To explore the API, we provide interactive documentation using Swagger UI. Once the app is running locally, you can access the API docs at:
http://localhost:4000/logistic-app/api-documentation
