Mobility App Backend

---

Mobility App

---

Thank you very much for your interest in my project. It's the last proyect, a complete full stack project with Geekshubs Academy of the Full Stack Development Bootcamp 🚀.

---

Contents 🗂️

1. Full Description
2. Data Base diagram
3. Tasks
4. Instalation & Develop
5. Author / Contact

It an app to hire a service to transport people from one place to another paying a price for it..

Full Description 📝

Users can register for the application, log in and access it. They can search for a destination, choose from different types of cars and make the trip. A driver responds to the request and picks up the passenger. Once the trip is completed, they can rate the driver. Users must complete their profile and choose the payment method. They can also access their trip history.

Data Base Diagram

Tasks 📝

Create a Data Base

Migrations & Seeders for all tables.

Endpoints

View endopints

---

Authentication

---

1. Register Users

POST localhost:5500/auth/register

2. Login

POST https://localhost:5500/auth/login

---

3. Register Drivers

POST localhost:5500/auth/drivers/register

4. Login

POST localhost:5500/auth/drivers/login

---

Users

---

5. Get All Users with pagination

GET http://localhost:5500/users

---

6. Pagination example

"url_example_of_pagination":"http://localhost:5500/users?page=2",

"url_example_of_pagination1":"http://localhost:5500/users?limit=20",

"url_example_of_pagination2":"http://localhost:5500/users?page=3&limit=15"

---

7. Get User Profile

GET http://localhost:5500/users/profile

---

8. Update User Profile

PUT http://localhost:5500/users/profile

{ "userName": "Jhon Smith", "phone": "+3461371436", "address": "carrer xativa 20", "payment": "credit" }

---

9. Delete User by Id

DELETE http://localhost:5500/users/:id

---

10. Delete one User or more by Id arrays (superAdmin)

DELETE http://localhost:5500/users

{ "usersId" : [4,5,7,5,78,2] }

{ "usersId" : [12] }

---

11. Get Users with search by query

GET http://localhost:5500/users/search?search=email

GET http://localhost:5500/users/search?search=name

---

12. Create Trip

POST http://localhost:5500/trips/

{ "startLocation": "[39.5102451,-0.4115579]", "destination": "Valencia, Spain", "driverId": 3 }

---

13. Get all Trips (Super_admin)

GET http://localhost:5500/trips/all

---

14. Get my all Trips (TOKEN)

PUT http://localhost:5500/trips/:id

---

15. Get trips by Id (TOKEN)

GET http://localhost:5500/trips

---

16. Update Trip (TOKEN)

PUT http://localhost:5500/trips/

{ "tripDate": "2024-05-01 19:00:00", "trip_id": 23, "driverId": 4, "startLocation": "Godella", "destination":"Palau de Congresos", "carId":2 }

---

17. Update Trip by Id (TOKEN)

PUT http://localhost:5500/trips/:id

---

18. Delete Trip by Id (TOKEN)

DELETE http://localhost:5500/trips/:id

---

19. Delete more than one Trips by Id array (superAdmin)

DELETE http://localhost:5500/trips

{ "tripsId" : [4,2,5,6,8,10] }

{ "tripsId" : [6] }

---

20. Get All Drivers with pagination

GET http://localhost:5500/drivers

---

21. Pagination Example

url_example_of_pagination":"http://localhost:5500/drivers?page=2

"url_example_of_pagination1":"http://localhost:5500/drivers?limit=20",

"url_example_of_pagination2":"http://localhost:5500/drivers?page=3&limit=15"

---

22. Get Driver Profile

GET http://localhost:5500/drivers/profile

---

23. Update Driver Profile

PUT http://localhost:5500/drivers/profile

---

24. Delete Driver by Id

DELETE http://localhost:5500/drivers/:id

---

25. Delete one Driver or more by Id arrays (superAdmin)

DELETE http://localhost:5500/drivers

{ "driversId" : [4,5,7,5,78,2] }

{ "driversId" : [12] }

---

All non-public endpoints with corresponding middlewares

We can find here the collection of all endpoints in Thunder Client: You have to open Thunder Client Go to collections Import this file:



./HTTP/thunder-collection_TAXI APP.json

---

Instalation & Develop ⛏️

1. INSTALL DOCKER



1. Install docker and run this command to get a container

$ docker run --name mysql-exampleName -p 3309:3306 -e MYSQL_ROOT_PASSWORD=1234 -d mysql

2. Example

$ mysql -h localhost -P 3306 -u root -p you will need -h (host), -P (port), -u(username) and -p (password)

2. INSTALL EXPRESS



$ npm init

1. Run follow command to create "package-lock.json" install node_modules

$ npm install express --save

2. Create .gitignore in root and add "./node_modules" , ".env" and ".dist" to avoid upload to github repository
3. 

$ npm install typescript -D

4. Create the 'tsconfig.json' file

$ npx tsc --init

5. Install types/express & node

$ npm install @types/express @types/node -D

6. Install dependencies to compile TS (nodemon)

$ npm install ts-node nodemon -D

7. Create ".env" and ".env.example" file The .env file has the key & value credentials to access to the data base. It should not be visible, for this reason we add it to .gitingnore. The ".env.example" files have the same structure to build your ".env" file on your local
8. Put the follow keys in .env file.

PORT =4XXX

#conexion a bd
DB_USER=root
DB_PASSWORD=XXXX
DB_PORT=33XX
DB_HOST=localhost
DB_DATABASE=dataBaseName

# JWT

JWT_SECRET=xxxxxx



9. Install 'dotenv' to added th depencencies and will grab data from the .env file

$ npm install dotenv

10. DOTENV - Create the folder "src" with "server.ts" file inside. This the code to connect to the server.

import "dotenv/config"

import { app } from "./app"
import { AppDataSource } from "./database/db"

const PORT = process.env.PORT || 5500

const startServer = () => {
  AppDataSource.initialize()
    .then(() => {
      console.log("database connected")
      app.listen(PORT, () => {
        console.log(`Server is running on port: ${PORT}`)
      })
    })
    .catch((error: any) => {
      console.log("error")
    })
}

startServer()

11. We create app.ts file

// links to .env file
import express, { Application } from "express"
import "dotenv/config"
import { authRouter } from "./routes/authRoutes"

// export app function export
const app: Application = express()
// parses response to .json
app.use(express.json())
// testing request
app.get("/healthy", (req, res) => {
  res.status(200).json({
    success: true,
    message: "Server is healthy",
  })
})
// auth Users & Drivers
app.use("/", authRouter) //<-- Route Example

3. CREATE MYSQL



1. Think and rethink the database, avoid redundancy between keys and related tables. Identify primary keys (PK) and foreign keys (FK). Choose the type of value, if it is 'NULL' (not required) or can be 'UNIQUE' fields.
2. Open Mysql Workbench and set up new dataBase connection

3. $ npm run dev

   ---

4. MIGRATIONS & MODELS

• Creating MIGRATIONS [Data Definition Language (DDL): with typeorm]: $ npm run run-migrations ./src/database/migrations

• It's possible that's need populate with one basic table before continue with the migrations go to the point 11.Run Project

• Adding them to DataSource.migrations in the db.ts file: Role, User, Driver, Trip, Car, Brand

• Creating MODELS (entities) [Data Manipulation Language (DML)]

• Adding them to DataSource.entities in the db.ts file: Roles, Users, Drivers, Trips, Cars, Brands

5. CONTROLLERS
• We create controllers (in a folder on the same level with package.json): > auth, users, drivers, trips
6. ROUTES
• We create routes (in app.ts) for CRUD (create, read, update and delete) database records for users ,drivers, trips.
7. MIDDLEWARE: auth( )
• Additionally we need to control access to our data. We will use 'middleware' functions.

• Auth(authorization system based on TOKENs) will block anything that should not be seen by the general public. In our case, it only does not affectregister, loginandgetServices` (since those are the endpoints accessible without logging in).
• The auth() function verifies an encrypted TOKEN created automatically at login. With an active token we have access to other data.
8. MIDDLEWARE: isSuperAdmin()
• We also want to grant special administrative access. With another middleware, the isSuperAdmin() function, we control PERMISSIONS.
• The 'superadmin' role would be able to reach all data, while Users would have a more limited reach. More levels can be implemented
9. TOKENDATA

• For the TOKEN to work, we create a new file ./types/index.d.ts with the following lines: We must add driverId, because in this project we have auth users and auth drivers, and we need both to use tokenData.

  export type TokenData = {
  driverId: number
  userId: number
  roleName: string
  }
  declare global {
  namespace Express {
  export interface Request {
  tokenData: TokenData
  }
  }
  }

10. SEEDERS

• In order to check out this project, you'll need to populate the database. We create a seeders.ts file, we use the npm faker library to create fake users, cars and drivers.

$ npm run seed

11. RUN PROJECT

1. Clone this repository
2. Run in terminal

$ npm install

3. Conect repository with database
4. Run migrations:

$ npm run run-migrations

5. Run seeders:

$ npm run seeders

6. Start server:

$ npm run dev

---

- super_admin & random user - Credentials

{
"first_name": "Super",
"last_name": "Super"
"email": "[email protected]"
"password": 123456,
"role_id": 3
}

{
"first_name": "user",
"last_name": "user"
"email": "[email protected]"
"password": 123456,
"role_id": 1
}

Deployment

The next steps is deploy the full proyect

---

Author