mateussvictor / my-contacts-api

:iphone: An API to manage your contacts!

MyContacts API

📌 Contents

• Features
• Getting started
• Technologies
• License

⚡ Features

• CRUD operations
• Filter and sort contacts
• Add contact number
• Associate contacts to some category

🏃 Getting started

First you need to install Node and Yarn.

# Open a terminal and copy this repository with the command
$ git clone [email protected]:mateussvictor/my-contacts-api.git

# Enter the directory with
$ cd my-contacts-api

# Install dependencies
$ yarn

Create your environment variables based on the examples of .env.example

cp .env.example .env

Preparing the Database

• Install PostgreSQL and set your env variables to connect to the DB, OR if you have Docker in your machine, you can run the commands below:

# Create container and set Database
$ docker compose up -d

# Stop container
$ docker compose stop

Run the following command to start the app:

yarn dev

🛠️ Technologies

Some of the technologies and tools used:

• Node
• Express
• PostgreSQL
• Husky
• Commitlint
• Lint-staged