https://github.com/marlonperez-01/authserver

API REST encargada de autenticar y autorizar usuarios por medio de JSON Web Tokens
https://github.com/marlonperez-01/authserver

Last synced: 7 days ago
JSON representation

API REST encargada de autenticar y autorizar usuarios por medio de JSON Web Tokens

• Host: GitHub
• URL: https://github.com/marlonperez-01/authserver
• Owner: MarlonPerez-01
• Created: 2022-03-16T05:42:43.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-16T05:43:54.000Z (almost 3 years ago)
• Last Synced: 2024-04-25T04:32:24.908Z (10 months ago)
• Language: TypeScript
• Size: 74.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# API REST para autenticación y autorización

API REST encargada de autenticar y autorizar usuarios por medio de JSON Web Tokens escrita en typescript utilizando el framework Express.

## Empezando

### Dependencias

- [Mysql](https://www.mysql.com/)

- [NodeJS](https://nodejs.org/en/)

### Configuración

- Clonar este repositorio

```sh

git clone https://github.com/MarlonPerez-01/AuthServer.git

```

- Navegar al directorio del proyecto

- Ejecutar `npm install` o `npm i` para la instalación de dependencias.

- Crear el archivo `.env` y copiar el contenido del archivo `.env.sample` y asignar los valores a cada variable.

- Crear la base de datos en MySQL a partir del script database.sql

### Ejecutar

- Ejecutar `npm run dev` para iniciar la aplicación en modo de desarrollo.

## Estructura del proyecto

    .

    ├── ...

    ├── src                             # Dentro se encuentran los ficheros fuentes

    │   ├── config                      # Configuración y conexión a la base de datos

    │   ├── controllers                 # Controladores

    │   ├── helpers                     # Funciones para resolver tareas específicas

    │   ├── interfaces                  # Definición de interfaces

    │   ├── middlewares                 # Middlewares

    │   ├── models                      # Queries a la base de datos

    │   ├── routes                      # Rutas de la API

    │   ├── types                       # Definición de tipado

    │   ├── validations                 # Esquemas a validar

    │   ├── app.ts                      # Llamadas a las funciones principales

    │   └── server.ts                   # Llamadas a middlewares generales

    ├── .env                            # Fichero de variables de entorno

    ├── .env.sample                     # Fichero de variables de entorno de ejemplo

    ├── .gitignore                      # Fichero para ignorar archivos en github

    ├── .prettierrc                     # Configuración del formato de código

    ├── error.log                       # Fichero de logs del servidor

    ├── package-lock.json               # Mantener versión de cada paquete

    ├── package.json                    # Información del proyecto, scripts y dependencias

    ├── README.md                       # Documentación

    ├── tsconfig.json                   # Configuración de typescript

    └── ...

## Endpoints

### GET

`/usuarios/:id`

### POST

`/auth/signup`\

`/auth/signin`\

`/auth/verify-email`\

`/auth/refresh-token`\

`/auth/logout`\

`/auth/change-password`\

`/auth/forgot-password`\

`/auth/reset-password`\

`/auth/resend-verification-email`

### PUT

`/usuarios/:id`