devigorgarcia / htttinder-api-v2

Table of Contents

1. Documentation
2. About The Project
   • Built With
3. Getting Started
   • Prerequisites
   • Recommended
4. Installing
5. Installing with docker
6. Usage Examples
7. Team

---

Project Overview

Kenzie Love is an application designed to connect people through their common interests.

The development process of this project prioritized creating a flexible and user-friendly environment, always taking into account their security.

In its basic use the user needs to fill the profile information, being able to add photos, personal interests and express what they're looking for in their connections, be it a serious or casual relationship, even simple friendship. In this way the algorithm will return the best match option based on the information passed in the profile.

---

Built With

• Express
• bcryptjs
• cloudinary
• express-async-errors
• jsonwebtoken
• multer
• nodemailer
• pg
• typeorm
• yup
• class-transformer
• class-validator
• dotenv

Sumary

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Nodejs
• Git
• PostgresSQL:14

Recommended

• Visual Studio Code - IDE

---

Installing

• Clone repository

git clone [email protected]:httTinder/httTinder-Api.git

• Copy the environment variables

 cp .env.exemple .env

• Install dependencies

npm install

yarn

• Run the Migrations

npm run typeorm migration:run -d src/data-source.ts

yarn typeorm migration:run -d src/data-source.ts

• Start application

npm run dev

yarn dev

Installing with docker

• Build application

docker-compose up --build

• Start application

docker-compose up

Usage

Base URL

https://htttinder.herokuapp.com

POST /user

Route responsible for creating new user

• Required fields

  Field	Type	Description
  name	string	User's Name
  email	string	User's Email
  password	string	User's Passowrd
  age	string	user's Age

• Example:

    {
        "email" :"[email protected]",
        "name" : "fabio jose casanova",
        "password" : "2209",
        "age" : "33"
    }

---

PATCH /user/profile/:id

Route responsible for creating user profile or update any field on the user profile

• Required fields

  Field	Type	Description
  orientation	string	User's Name
  gender	string	User's Gender
  bio	string	User's Short biography
  height	string	User's Height
  education	string	User's Education
  profession	string	User's Profession
  profileImage	string	User's Photo

  
  

< This route requires authentication>

If the id is not passed through params, the one provided by the token will be used.

• Example:

   {
    "orientation" : "hétero",
    "gender" : "Homem",
    "bio" : "sou bem legal",
    "height": 1.85,
    "education" : "Formado",
    "profession" : "Dev",
    "profileImage" : "12530000"
    }

Expected Response:

   {
    "message": "Profile changed successfully"
    }

Errors:

• 400 : errors relating to the data reported in the field, check whether the data respects the maximum size or has been informed.
• 401 : error may refer to the validity of the token, the user, or whether the user was not adm.
• 403 : error regarding lack of authorisation.
• 404 : error user was not found

---

DELETE /user/profile/:id

Route responsible for delete the profile

• No body required

< This route requires authentication>

If the id is not passed through params, the one provided by the token will be used.

Expected Response:

   {
    "message": "Profile deleted with sucess!"
    }

Errors:

• 400 : errors relating to the data reported in the field, check whether the data respects the maximum size or has been informed.
• 401 : error may refer to the validity of the token, the user, or whether the user was not adm.
• 403 : error regarding lack of authorisation.
• 404 : error user was not found

For more examples, please refer to the Documentation

---

back to top

Team

Quality assurance Diego Guimarães

Tech Lead Fábio Casanova

Dev | UX/UI Fábio Junior

Quality assurance Igor Garcia

PO | UX/UI Mari Spinola

Scrum master Matheus Freire