Francisco-Villanueva/box-api

Box Delivery - APP

See the frontend repository - Client »

Table of contents

1. About the Project
2. Built With
3. Getting Started
   • Installation
4. Contributing
   • Report Bug - Request feature
   • Pull Request
5. Contact

1. About the Project

A last mile logistics company has hundreds of delivery drivers who at the beginning of the day receive ~10 packages each and who must distribute throughout the day.

The company must be able to monitor the operation of delivery people, assign or reassign packages and intervene if necessary to edit a shipment to modify the address or reassign the shipment to another delivery person.

An application will be developed with two different roles:

Application with delivery role: delivery people will be able to register and log in freely and select the packages to be delivered that day with a maximum of 10.

Application with administrator role: the company will be able to see the list of registered delivery people, how many delivery people are active with deliveries in progress, how many packages each delivery person has, create, view and edit the packages that must be sent.

⬆ Back to top

2. Built With

In the table below, you can see the complete list of the various technologies and libraries that we have used for the development and creation of this project.

NodeJS	MongoDB	Typescript
Nest	Mongoose	JWT

⬆ Back to top

3. Getting Started

This project is not yet deployed, but you can try it in your local. Follow the instructions below to run it.

💠 INSTALLATION

1. Clone the repository

   git clone https://github.com/Francisco-Villanueva/box-api

2. Install NPM dependencies

   npm install

3. Create a file in the root .env.local then use the .env.example file found in this repository as a base

    PORT=someport
    SECRET_PASSWORD=somevalue
    MONGO_URI=someuri
    CLIENT_HPOT=somehostclient

4. Run the server

   npm run server

⬆ Back to top

4. Contributing

If you have any suggestion to improve the project or you find a bug you can inform us, please choose one of the following options

💡 REPORT BUG - REQUEST FEATURE

1. 👉 Report bug - request feature

💡 PULL REQUEST

1. FORK to the project.
2. Create your Feature Branch (git checkout -b feature/my-feature)
3. Commit your Changes (git commit -m 'feat: feature description')
4. Push to the Branch (git push origin feature/my-feature)
5. Open a Pull Request

⬆ Back to top

💡 GIT FLOW

Commits

• fix: description of the fix
• feat: description of the feat
• chore: description of the chore

Branches

• fix/name-of-fix-branch
• feat/name-of-feat-branch
• chore/name-of-chore-branch

Pull Request

• fix(context): description of the fix branch
• feat(context): description of the fix feat
• chore(context): description of the fix chore

5. Contact

Francisco Villanueva: Developer

Braian Barrientos: Developer

Agustín Torroja: Developer

Dario Beratti: Developer

Mateo Navarro: Developer

⬆ Back to top