Manage your restaurant with ease and provide the best service to your customers with this Restaurant API. Designed for a single restaurant, it provides all the features you need to keep your restaurant's information up-to-date, with support for rate limiting, authentication, and error handling. Automated tests ensure reliability, and the API is easily deployable.
Docs
·
Have a question?
·
Request Feature
This project was built using the Node.js runtime and the Express.js framework, with TypeScript used as the primary language. To handle database operations, the project uses the Prisma ORM, with PostgreSQL as the database management system. For testing purposes, Jest was used.
For run this project, you will need the following things:
- Node.js
- NPM
- Docker
- Docker Compose (Only for the test)
And you need to download the project in your computer.
After fill all requirements, you need to run one of the following commands for install the modules.
npm installFor use the project you need to run following command:
npm run devIf you'd like to contribute to this project, please follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b feature/your-feature. - Make your changes and commit them:
git commit -m 'Add some feature'. - Push to the original branch:
git push origin feature/your-feature. - Create a pull request.
Julio Martins
Make by Julio Martins 👋🏽 Contact me!
