https://github.com/rdvid/pdv-api-ifood

Api for logistical controller developed through a partnership program with IFood
https://github.com/rdvid/pdv-api-ifood

aws-s3 bcrypt-nodejs bucket git-flow jest nodejs postgresql rest-api swagger typescript

Last synced: 9 months ago
JSON representation

Api for logistical controller developed through a partnership program with IFood

• Host: GitHub
• URL: https://github.com/rdvid/pdv-api-ifood
• Owner: rdvid
• License: mit
• Created: 2023-04-13T23:56:38.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-16T00:34:33.000Z (over 2 years ago)
• Last Synced: 2024-11-09T00:55:50.789Z (over 1 year ago)
• Topics: aws-s3, bcrypt-nodejs, bucket, git-flow, jest, nodejs, postgresql, rest-api, swagger, typescript
• Language: TypeScript
• Homepage: https://concerned-pink-kingfisher.cyclic.app/api-docs
• Size: 365 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  





![Express](https://img.shields.io/badge/Express-000000?style=for-the-badge&logo=express&logoColor=white)

![Typescript](https://img.shields.io/badge/Typescript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

![Jest](https://img.shields.io/badge/Jest-000000?style=for-the-badge&logo=jest&logoColor=red)

![Postgres](https://img.shields.io/badge/Postgresql-007ACC?style=for-the-badge&logo=postgresql&logoColor=white)

![Git](https://img.shields.io/badge/Git-000000?style=for-the-badge&logo=git&logoColor=red)

![AWS](https://img.shields.io/badge/Aws-000000?style=for-the-badge&logo=amazon&logoColor=red)





     



"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 `.

3. Do your alterations and tell then in your commit message: `git commit -m ''`

4. Send then to origin fork: `git push origin  / `

5. Create a pull request detailing your implementation.

[How to create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-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