https://github.com/osamaadam/saloodo-assessment

Full stack application created as a part of Saloodo's recruitment process
https://github.com/osamaadam/saloodo-assessment

nestjs nodejs postgres react typeorm typescript

Last synced: 4 months ago
JSON representation

Full stack application created as a part of Saloodo's recruitment process

• Host: GitHub
• URL: https://github.com/osamaadam/saloodo-assessment
• Owner: osamaadam
• Created: 2023-02-13T00:20:03.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-05-02T07:37:17.000Z (about 2 years ago)
• Last Synced: 2024-12-30T20:33:45.094Z (6 months ago)
• Topics: nestjs, nodejs, postgres, react, typeorm, typescript
• Language: TypeScript
• Homepage:
• Size: 554 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Parcel Delivery

## Description

This is a simple application that allows you to create a parcel delivery order. It also allows you to view all the orders that have been created. Created as part of Saloodo's coding challenge.

## Installation

- Clone the repository

- Run `docker-compose up` to start the application

This will spin up the containers for the server, client, and the Postgres database.

By default the server will be running on port 4000 and the client on port 3000. The server will populate the database with some sample data if it detects that the `NODE_ENV` variable is equal to `development`.

## Usage

Access the client at `http://localhost:3000`.

By default, there'll be 5 different clients, and 5 different bikers.

Each client will have 25 parcels, all pending.

To login as a client, use the following credentials:

- email: `[email protected]`

- password: `123`

> Note: The password is the same for all clients.

> The email for each clients follows the pattern `client.${i}@test.com` where i is between 0 and 4.

To login as a biker, use the following credentials:

- email: `[email protected]`

- password: `123`

> Note: The password is the same for all bikers.

> The email for each bikers follows the pattern `biker.${i}@test.com` where i is also between 0 and 4.

Only bikers can pickup and deliver parcels, and only clients could create parcels.

You may always create new clients by going to the `/signup` route.

## Screenshots

### Client view

![Client view](./assets/client_view.png)

### Biker available view

![Biker available view](./assets/biker_available_view.png)

### Biker picked view

This view is populated after the biker has picked up parcels from `/biker` route.

![Biker picked up view](./assets/biker_picked_view.png)