flossyyuri/bravi-people

Bravi People

An app that allows you to store people and their contacts.
View App · Get in touch

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Requirements
4. Contact

About The Project

A Progressive Web Application that allows any user to search, save, update and delete contacts. Click Here to see the Figma Prototype

Built With

• React.js
• NEST.js
• PostgreSQL

Getting Started

To get a local copy up and running follow these simple steps:

Prerequisites

Before trying to run the project you should have installed Node.JS, Yarn Package Manager and Docker for Desktop.

• YARN

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/FlossyYuri/bravi-people.git

Backend

1. Enter the backend folder

   cd backend

2. Install Yarn packages

   yarn

3. Run docker container to start the postgres database (after starting docker)

   docker-compose up -d

4. Configure environment variables

• Copy and Past .env.example
• Change the copy file to .env

5. Start Project

   yarn start:dev
   

Front

1. Enter the frontend folder

   cd frontend

2. Install Yarn packages

   yarn

3. Configure environment variables

• Copy and Past .env.example
• Change the copy file to .env

4. Start Project

   yarn start

Requirements

• Feature 1
  • Description 1
  • Description 1
• Feature 2

Contact

Émerson Yuri Cuambe - LinkedIn - Email

Project Link: https://bravi-people-iy3zxzh07-flossyyuri.vercel.app/contacts

(back to top)