Labeddit

Table of Contents

1. About The Project
   • Built With
2. Documentation
3. RoadMap
4. Estructure REST
   • Methods
   • Response
5. Getting Started
   • Installation
6. Usage
7. FrontEnd Repository
8. Contact
9. Acknowledgments

About the project

O Donko é uma aplicação web que será projetada para ser uma plataforma completa que serve como guia para eventos culturais, desde shows musicais até exposições de arte, teatro e outras opções de entretenimento.

Built With

• NodeJS
• Typescript
• Express
• SQL e SQLite
• Knex
• POO
• Layered architecture
• UUID
• Password hashed
• Autentication and autozrization
• Router
• Postman

Documentation

Ducumentation of the API with instrutions on how to use the endpoints avalible for the Labeddit aplication

DONKO-RIO API

RoadMap

• Endpoints

  • Users
    • Create new User
    • Login User
    • Edit User
    • Delete user
  • Events
    • Get All Events
    • Create new Event
    • Edit Event
    • Delete Event

• Authentication and authorization

  • UUID
  • Hashed passwords with Bcrypt.
  • tokens JWT

• Code

  • POO
  • Layered architecture
  • Router in Express
  • SOLID
  • Clean code

Methods

Requests for the API must follow HTTP RESTful patterns.

Methods	Description
GET	Returns information for one or more records.
POST	Used to create a new record or login access.
PUT	Updates data for a record or changes its status.
PATCH	Partially updates data for a record.
DELETE	Removes a record from the system.

Response

Código	Descrição
200	Request successfully executed (success).
201	Data created successfully (success).
400	Validation errors or fields provided do not exist in the system.
404	Searched record not found (Not found).
409	The user already exists in the system. (Conflict).
500	Unexpected error.

Getting Started

Here is an example of instructions on how to set up the project locally. To have a local copy, follow the steps below:

Instalation

1. Clone repository

git clone https://github.com/Afmjuniors/labeddit-back.git

2. Install NPM TypeScript packages

npm init -y (create package.json)

npm i -g typescript (just once)

npm i typescript -D (install typescript in the project)

npx tsc -init (create tsconfig.json)

3. Install All Packjson dependencies

npm install

4. Run NPM developer

npm run dev

Usage

O Donko é uma aplicação web que será projetada para ser uma plataforma completa que serve como guia para eventos culturais, desde shows musicais até exposições de arte, teatro e outras opções de entretenimento.

FrontEnd-Repository

To see repository of this application Front-end

Contact

Alexandre Machado - FullStack - afmjuniors@gmail.com

Samantha Bianchi- Front - sahlsb2@gmail.com

Marina Jaudy - UI/UX - Front - mbuzina@hotmail.com

Mônica Jesus - ADM - monicajprado@outlook.com

Acknowledgments

• Gostaria de agradecer a todo time que participou comigo do hackthon, vocês foram feras
• Gostaria tambem de acredecer ao staff do hackthon, pricipalmente ao Johnny que nos aconcelhou sempre que necessario