khriztianmoreno / backend-top-v29

Backend Top-v29 - Make It Real 💻

Main base of the services used within the Make It Real platforms

• Built with Node.js and Express
• Typescript
• Prisma ORM
• REST API

Prerequisites

• Git
• Volta.sh
• Node.js and npm Node >= 18.15 LTS, npm >= 9.5.x - Install with Volta.sh

Express Router and Routes

Route	HTTP Verb	Route Middleware	Description
/api/healthcheck	GET		Show a simple message
/api/users	GET		Get list of users
/api/users	POST		Creates a new users
/api/users/:id	GET		Get a single users
/api/users/:id	DELETE		Deletes a user

Usage

The use of endpoints is very simple, previously you could see a table of endpoints that you can call, if you need to create a note or log in, here we have some examples.

Authentication user /auth/local/login

Request Body:

{
  "email": "[e-mail]",
  "password": "12345"
}

Response:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImNyaXN0aWFuLm1vcmVub0BtYWtlaXRyZWFsLmNhbXAiLCJpYXQiOjE2NjEyMDgwODJ9.kPdMoVUEnyX36vi606Mc1C66yWLKKAB37GLbF0gzhBo",
  "profile": {
    "id": "62fd77a4d25acc4a4e5df3d1",
    "firstName": "CRISTIAN",
    "lastName": "MORENO",
    "email": "[e-mail]"
  }
}

Basic example Create User /api/users

Request Body:

{
  "name": "cristian moreno",
  "email": "[e-mail]",
  "password": "123456",
}

Response:

{
  "name": "cristian moreno",
  "email": "[e-mail]",
  "role": "USER",
}

Developing

1. Clone the repository: git clone [e-mail]:khriztianmoreno/backend-top-v29.git

2. Run npm install to install server dependencies.

3. Configure the env running cp .env.example .env

4. Update .env with the required info

5. Run the migrations: prisma migrate dev

6. Run npm run dev to start the development server.

License

MIT