Skip to content

SortOmega/CourseProject-NodeJS-RESTAPI

Repository files navigation

PROYECTO EXPRESS CON TYPESCRIPT

Descripción

Aplicación web API REST CRUD, elaborada mediante Node.js y Express.js, basado en el proyecto del Curso de Node.js del Youtuber del canal "Desarrollo Útil". El lenguaje utilizado fue Typescript, para darle agregarle un poco de diferencia y complejitud al proyecto. Mas información detallada sobre el proyecto se puede encontrar en el repositorio oficial del Youtuber "Desarrollo Útil".

Uso de API / API Usage

  • ES: Ruta Principal.
  • EN: Main Route
[<ServerIP>:<port>]/api/

-> User Router EndPoints

  • user/register

POST /api/user/register

Request Body: "application/json"

{
    "_id": "uuid string format",
    "name": "string",
    "surname": "string",
    "email": "email string format",
    "password": "string"
}

Paquetes Usados

  • ✅ express
  • ✅ dotenv
  • ✅ ajv
  • ✅ ajv-formats
  • ✅ ajv-errors
  • ✅ jose
  • ✅ bcrypt
  • ✅ mongoose
  • ✅ @sinclair/typebox

Paquetes de Desarrollo Usados

  • ✅ typescript
  • ✅ ts-node-dev
  • ✅ @types/express
  • ✅ @types/dotenv
  • ✅ @types/node
  • ✅ @types/bcrypt

Proceso de instalacion

  • Dentro de la carpeta del proyecto, en una terminal o consola, ejecutaremos:
npm install
  • Esto nos instalara todos los paquetes o dependecias de node que se encuentran en el archivo package.json

Herramientas / Lenguajes

Scripts del Proyecto

  • Iniciar la configuracion de typescript desde npm, obviando el primer parametro (que representa a npm) y el segundo parametro con 'init' (que representa a tsc)
npm run tsc -- --init
  • Vigilador de cambios y autoejecutacion para Typescript:
npm run dev
  • Transpila todo el proyecto de Typescript a Javascript en una carpeta "build"
npm run tsc
  • Ejecuta el Proyecto construido en "build" para produccion.
npm start

Creditos

Screenshots

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published