"Pensou comida? Pensou iFood!!"

💡 What is it?

A API for a PDV software, developed for selling management. Including CRUD features, User roles, Authentication and Authorization, Image uploading, Email sending and more....

Technologies used

• Typescript
• Express
• Jest
• Postgres
• AWS-S3
• Backblaze Bucket
• SwaggerUI
• Knex (Query Builder)

✨ Highlights

Some features that we are proud for implement:

• Web documentation generated with Swagger.
• Unit tests with Jest.
• Error handling using exceptions.
• Typescript implementation for secure development.
• JWT Auth flow.
• Customized email template sent using nodemailer.
• AWS-S3 sdk implementation for Image Storing.
• Deployed using Cyclic.

⚙️ Next Features

The development process starts but never ends. Next features will be focused on:

• Dockerize application.
• User Interface implementation.
• Redis for caching.
• More patterns, like clean code and KISS for code review.

📫 Find a bug or have any suggestion?

Pull Requests

1. Fork this repo.
2. Create a branch: git checkout -b <branch_name>.
3. Do your alterations and tell then in your commit message: git commit -m '<commit_message>'
4. Send then to origin fork: git push origin <project-name> / <local>
5. Create a pull request detailing your implementation.

How to create a pull request.

Issues

1. Access the Issues Section:
2. Click the “New issue” button.
3. In the “Title” field, type a descriptive title for your issue.
4. In the comment body field, provide a detailed description of the issue you’re facing or the feature you’d like to request.
5. Apply labels to categorize the issue.
   • Enhancement for new features
   • Bug for some issue in usability
6. Click “Submit new issue” to create the issue.

With ❤️ by Debuggers Team:

Thiago Lima

Rafael David

Wladimir Silva