EPA_backend

backend

Locally instantiate the database

Para instanciar de manera local la base de datos, se requieren seguir los siguientes pasos: Primero que nada debemos crear nuestro archivo .env localmente en la raíz de EPA-backend, que debe ser el siguiente:

DB_USERNAME = epaowner
DB_PASSWORD = epapassword
DB_NAME = epachat
DB_HOST = 'localhost'
JWT_SECRET = un_dia_vi_una_vaca_sin_cola_vestida_de_uniforme
FRONTEND_URL = https://epachat.netlify.app/

Una vez realizado esto, debemos entrar a postgresql con el superusuario por defecto:

sudo -U postgres psql

Una vez dentro, crear un usuario de tipo superuser de nombre "epaowner" y contraseña "epapassword":

CREATE USER epaowner WITH SUPERUSER PASSWORD 'epapassword';

Creado el usuario, debemos crear la base de datos con el usuario anteriormente creado:

CREATE DATABASE epachat OWNER epaowner;

Una vez creada la base de datos, debemos salir de postgresql:

\q

Ahora, debemos dirigirnos hacía la raíz de EPA_backend y escribir los siguientes comandos en la terminal:

yarn sequelize-cli db:drop      # Borrar base de datos del proyecto (opcional)
yarn sequelize-cli db:create    # Crear la base de datos del proyecto
yarn sequelize-cli db:migrate   # Realizamos las migraciones
yarn sequelize-cli db:seed:all  # Instanciar datos de semillas (opcional)

Una vez hechos los pasos anteriores, es posible que haya un error al querer hacer yarn dev. Para solucionarlo, en el archivo config.js debemos cambiar la linea de "ssl", donde en vez de tener todos los parametros que tiene encerrados por una llave, solo debe decir lo siguiente para las 3 bases de datos (development, test y production):

ssl: false

Lo anterior sucede principalmente porque la configuración de la base de datos está hecha para que funcione en linea, con las medidas de seguridad necesarias.

Por último, debemos escribir el siguiente comando en la raíz de EPA_backend:

yarn dev

De esta forma, podremos levantar la base de datos de manera local, la cual estará escuchando solicitudes en el puerto 3000 (http://localhost:3000).

Users

Get all users

Puedes encontrar todos los usuarios registrados utilizando /users endpoint.

[GET] https://epa-backend-1.onrender.com/users

Response:

[
    {
        "id": 2,
        "phoneNumber": "56987654321",
        "type": "user",
        "createdAt": "2024-06-14T02:25:05.900Z",
        "updatedAt": "2024-06-14T02:25:05.900Z"
    },
    // ...
]

Get a single user

Puedes encontrar un determinado usuario agregando como parámetro: /users/id

[GET] https://epa-backend-1.onrender.com/users/22

Response:

{
    "id": 22,
    "phoneNumber": "+56958632326",
    "type": "user",
    "createdAt": "2024-06-14T20:47:36.226Z",
    "updatedAt": "2024-06-14T20:47:36.226Z"
}

Delete a user

Para eliminar un usuario debes agregar id como parámetro: /users/id

[DELETE] https://epa-backend-1.onrender.com/users/22

Response:

true

Create a user

Puedes crear un nuevo usuario utilizando /signup endpoint. En la respuesta no se incluye la información del usuario, sólo se incluye un mensaje de confirmación, manteniendo la privacidad de los datos del usuario.

[POST] https://epa-backend-1.onrender.com/signup

Request:

{
    "phoneNumber": "+56987654321",
    "password": "1234abcd4321"
}

Response:

{
    "message": "User created"
}

Login as a user

Puedes iniciar sesión como usuario utilizando /login endpoint. En la respuesta se incluye un token de autenticación que debes utilizar en las siguientes solicitudes.

[POST] https://epa-backend-1.onrender.com/login

Request:

{
    "phoneNumber": "+56987654321",
    "password": "1234abcd4321"
}

Response:

{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJ1c2VyIl0sImlhdCI6MTcxODM3NDM1OSwic3ViIjoiNiJ9.r6lvNBx08kA7kS6SPs2kzJnM7qLMXUZ_WxDxTHK0aao",
    "token_type": "Bearer",
    "expires_in": 86400
}

See current user

Debido a que estamos creando un aplicación de chat, es importante poder acceder a la información del usuario actual. Puedes hacerlo utilizando /me endpoint.

[GET] https://epa-backend-1.onrender.com/me

Response:

{
    "id": 2,
    "phoneNumber": "+56987654321",
    "type": "user",
    "createdAt": "2024-06-14T02:25:05.900Z",
    "updatedAt": "2024-06-14T02:25:05.900Z"
}

See all messages

Puedes encontrar todos los mensajes enviados utilizando /messages endpoint.

[GET] https://epa-backend-1.onrender.com/messages

Response:

[
    {
        "id": 1,
        "content": "Hola, ¿cómo estás?",
        "senderId": 2,
        "receiverId": 1,
        "createdAt": "2024-06-14T02:25:05.900Z",
        "updatedAt": "2024-06-14T02:25:05.900Z"
    },
    // ...
]

See all messages within a conversation

Puedes encontrar todos los mensajes enviados en una conversación específica, definida por el id del chat utilizando /messages/ endpoint.

[GET] https://epa-backend-1.onrender.com/messages/1

Response:

[
    {
        "id": 1,
        "content": "Hola, ¿cómo estás?",
        "userId": 2,
        "chatId": 1,
        "state": "recieved",
        "createdAt": "2024-06-14T02:25:05.900Z",
        "updatedAt": "2024-06-14T02:25:05.900Z"
    },
    // ...
]

Send a message

Puedes enviar un mensaje a un usuario/chat específico utilizando /messages endpoint.

[POST] https://epa-backend-1.onrender.com/messages

Request:

{
    "content": "Hola, Estoy bien, gracias por preguntar",
    "chatId": 1,
    "userId": 1,
}

Response:

{
    "id": 2,
    "content": "Hola, Estoy bien, gracias por preguntar",
    "userId": 1,
    "chatId": 1,
    "state": "sent",
    "createdAt": "2024-06-14T02:25:10.900Z",
    "updatedAt": "2024-06-14T02:25:10.900Z"
}

Profile

Get all profiles

Puedes encontrar todos los profiles registrados utilizando /profiles endpoint.

[GET] https://epa-backend-1.onrender.com/profiles

Response:

[
    {
        "id": 2,
        "username": "John",
        "email": "johndoe@yahoo.com",
        "status": "Hello, I am John",
        "description": "I am an old man",
        "image": "https://i.pravatar.cc/150?img=68",
        "userId": 2,
        "createdAt": "2024-06-25T21:17:14.115Z",
        "updatedAt": "2024-06-25T21:17:14.115Z"
    },
    // ...
]

Get a single profile

Puedes encontrar un determinado perfil agregando como parámetro: /profiles/id

[GET] https://epa-backend-1.onrender.com/profiles/1

Response:

{
    "id": 1,
    "username": "Alex",
    "email": "alex@gmail.com",
    "status": "Hola, soy un test de patch",
    "description": "I am a software engineer",
    "image": "https://i.pravatar.cc/150?img=60",
    "userId": 1,
    "createdAt": "2024-06-25T21:17:14.115Z",
    "updatedAt": "2024-06-28T22:05:45.248Z"
}

Create a profile

Para crear un profile debemos utilizar /profiles endpoint con el método POST. Cabe recalcar que es importante que para crear un perfil, se debe primero haber creado un usuario con /signup.

[POST] https://epa-backend-1.onrender.com/profiles

Request:

{
    "username": "Test",
    "email": "test@yahoo.com",
    "status": "ok",
    "description": "hello I am a test",
    "image": "https://i.pravatar.cc/150?img=68",
    "userId": 9
}

Response:

{
    "id": 5,
    "username": "Test",
    "email": "test@yahoo.com",
    "status": "ok",
    "description": "hello I am a test",
    "image": "https://i.pravatar.cc/150?img=68",
    "userId": 9,
    "updatedAt": "2024-06-28T23:00:56.424Z",
    "createdAt": "2024-06-28T23:00:56.424Z"
}

Update a profile

Puedes actualizar la información de un profile con el endpoint profiles/userId, donde userId será la id del usuario al que pertenece dicho perfil.

[PATCH] https://epa-backend-1.onrender.com/profiles/5

Request:

{
    "username": "TestModificated"
}

Response:

{
    "id": 5,
    "username": "TestModificated",
    "email": "test@yahoo.com",
    "status": "ok",
    "description": "hello I am a test",
    "image": "https://i.pravatar.cc/150?img=68",
    "userId": 9,
    "createdAt": "2024-06-28T23:00:56.424Z",
    "updatedAt": "2024-06-28T23:20:37.746Z"
}

Contacts

Get all contacts

Puedes encontrar todos los contacts registrados utilizando /contacts endpoint.

[GET] https://epa-backend-1.onrender.com/contacts

Response:

[
    {
        "id": 1,
        "nickname": "Johnny",
        "userBase": 1,
        "userContact": 2,
        "createdAt": "2024-06-25T21:17:14.124Z",
        "updatedAt": "2024-06-25T21:17:14.124Z"
    },
    // ...
]

Get a single contact

Puedes encontrar un determinado contacto agregando como parámetro: /profiles/id.

[GET] https://epa-backend-1.onrender.com/profiles/1

Response:

{
    "id": 1,
    "nickname": "Johnny",
    "userBase": 1,
    "userContact": 2,
    "createdAt": "2024-06-25T21:17:14.124Z",
    "updatedAt": "2024-06-25T21:17:14.124Z"
}

Get all the contacts of a specific user

Puedes encontrar todos los contactos de un usuario en esepecífico utilizando el endpoint /contacts/user/userId.

[GET] https://epa-backend-1.onrender.com/contacts/user/2

Response:

[
    {
        "id": 3,
        "nickname": "Gold digger",
        "userBase": 2,
        "userContact": "+56944445678",
        "createdAt": "2024-06-25T21:17:14.124Z",
        "updatedAt": "2024-06-25T21:17:14.124Z"
    },
    // ...
]

Create a contact

Para crear un contact debemos utilizar /contacts endpoint con el método POST. Cabe recalcar que el número de telefono (userContact) es el que asocia el contacto con el usuario y su respectiva id.

[POST] https://epa-backend-1.onrender.com/contacts

Request:

{
    "nickname": "ContactTest",
    "userBase": 2,
    "userContact": "+56912345559"
}

Responde:

{
    "id": 6,
    "userBase": 1,
    "userContact": 9,
    "nickname": "ContactTest",
    "updatedAt": "2024-06-28T23:53:42.795Z",
    "createdAt": "2024-06-28T23:53:42.795Z"
}

Update a contact

Puedes actualizar la información de un contact con el endpoint contacts/contactId, donde ContactId será la id del contacto a actualizar.

[PUT] https://epa-backend-1.onrender.com/contacts/6

Request:

{
    "nickname": "ContactTestModificated"
}

Response:

{
    "id": 6,
    "nickname": "ContactTestModificated",
    "userBase": 1,
    "userContact": 9,
    "createdAt": "2024-06-28T23:53:42.795Z",
    "updatedAt": "2024-06-28T23:58:09.875Z"
}

Delete a contact

Para eliminar un usuario debes agregar id como parámetro: /contacts/id. Donde id será la id del contact a eliminar (parametro id del body, no condunfir con userBase o userContact).

[DELETE] https://epa-backend-1.onrender.com/contacts/6

Response:

Chats

Get all chats

Puedes encontrar todos los chats utilizando /chats endpoint.

[GET] https://epa-backend-1.onrender.com/chats

Response:

[
    {
        "id": 1,
        "title": "Two of us",
        "image": "",
        "createdAt": "2024-06-25T21:17:14.120Z",
        "updatedAt": "2024-06-25T21:17:14.120Z"
    },
    // ...
]

Get a single chat

Puedes encontrar un determinado chat agregando como parámetro: /chats/id.

[GET] https://epa-backend-1.onrender.com/chats/1

Response:

{
    "id": 1,
    "title": "Two of us",
    "image": "",
    "createdAt": "2024-06-25T21:17:14.120Z",
    "updatedAt": "2024-06-25T21:17:14.120Z"
}

Get all the messages of a specific chat

Puedes encontrar todos los mensajes de un chat en esepecífico utilizando el endpoint /chats/chatId/messages.

[GET] https://epa-backend-1.onrender.com/chats/1/messages

Response:

[
    {
        "id": 1,
        "userId": 1,
        "chatId": 1,
        "state": "sent",
        "content": "Hi, how are you?",
        "date": "2024-06-25T21:17:14.128Z",
        "createdAt": "2024-06-25T21:17:14.128Z",
        "updatedAt": "2024-06-25T21:17:14.128Z"
    },
    // ...
]

Get all the members of a specific chat

Puedes encontrar todos los miembros de un chat en esepecífico utilizando el endpoint /chats/chatId/members.

[GET] https://epa-backend-1.onrender.com/chats/1/members

Response:

[
    {
        "id": 1,
        "userId": 1,
        "chatId": 1,
        "role": "owner",
        "createdAt": "2024-06-25T21:17:14.134Z",
        "updatedAt": "2024-06-25T21:17:14.134Z"
    },
    // ...
]

Create a chat

Para crear un chat debemos utilizar /chats endpoint con el método POST.

[POST] https://epa-backend-1.onrender.com/chats

Request:

{
    "title": "chat Test",
    "Image": "chatImage.jpg"
}

Response:

{
    "id": 5,
    "title": "chat Test",
    "image": "chatImage.jpg",
    "updatedAt": "2024-06-29T00:34:22.414Z",
    "createdAt": "2024-06-29T00:34:22.414Z"
}

Update a chat

Puedes actualizar la información de un chat con el endpoint chats/chatId, donde ChatId será la id del chat a actualizar.

[PATCH] https://epa-backend-1.onrender.com/chats/1

Request:

{
    "title": "Two of us Modificated"
}

Response:

{
    "id": 1,
    "title": "Two of us Modificated",
    "image": "",
    "createdAt": "2024-06-25T21:17:14.120Z",
    "updatedAt": "2024-06-29T00:27:28.141Z"
}

Name		Name	Last commit message	Last commit date
Latest commit History 154 Commits
.github/workflows		.github/workflows
reviews		reviews
src		src
.gitignore		.gitignore
.sequelizerc		.sequelizerc
README.md		README.md
eslint.config.js		eslint.config.js
package.json		package.json
yarn.lock		yarn.lock

eanorambuena/EPA_backend

Folders and files

Latest commit

History

Repository files navigation

EPA_backend

Locally instantiate the database

Users

Get all users

Get a single user

Delete a user

Create a user

Login as a user

See current user

See all messages

See all messages within a conversation

Send a message

Profile

Get all profiles

Get a single profile

Create a profile

Update a profile

Contacts

Get all contacts

Get a single contact

Get all the contacts of a specific user

Create a contact

Update a contact

Delete a contact

Chats

Get all chats

Get a single chat

Get all the messages of a specific chat

Get all the members of a specific chat

Create a chat

Update a chat

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages