https://github.com/braien-machado/contact-list

https://github.com/braien-machado/contact-list

jest mocha-chai nodejs prisma react sinon styled-components testing-library typescript

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/braien-machado/contact-list
• Owner: braien-machado
• Created: 2022-07-13T17:50:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-18T21:51:35.000Z (over 2 years ago)
• Last Synced: 2023-03-06T20:17:49.880Z (almost 2 years ago)
• Topics: jest, mocha-chai, nodejs, prisma, react, sinon, styled-components, testing-library, typescript
• Language: TypeScript
• Homepage:
• Size: 3.44 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Contact List

This project is a simple contact list built from scratch.

![contact name interaction demo](./assets/contact-list-gif1)

![contact phone interaction demo](./assets/contact-list-gif2)

![contact email interaction demo](./assets/contact-list-gif3)

## Sumary

- [Description](#contact-list)

- [Technologies](#technologies)

- [Getting started](#getting-started)

- [Tests coverage](#tests-coverage)

- [Next steps](#next-steps)

## Technologies

- Backend:

	- Typescript

	- Node.js

	- MySQL

	- Prisma ORM

	- Tests: Mocha, Chai, Sinon

- Frontend

	- Typescript

	- React

	- Tests: Jest,  React Testing Library

## Getting Started

1. Clone the repository

	-  `git clone [email protected]:braien-machado/contact-list.git`

 2. Go to the cloned repository

	-  `cd contact-list`

2.   Install the dependencies

		- `npm install`

4. Build the mySQL database with *docker-compose*

	- `npm run compose:up`

	- Obs: If you get a timeout error in the first time running compose:up, remove the container and run the command again.

5. Create a *.env* file with a DATABASE_URL value as in *.env.example* if using db from my docker-compose or edit the value to use another mysql database

6. Go to backend directory and start the api

	-  `cd app/backend && npm start`

	- Obs: If you get a server error, check the db container status. While its status is not `Healthy` wait a little longer. When `Healthy`, run `npm start` again

7. Open another terminal, go to frontend directory and start the app

	-  `cd app/frontend && npm start`

8. If the app do not open automatically, search for http://localhost:3000/ in any browser

## Tests coverage

### Backend

1. Go to backend directory

	- `cd app/backend`

2. Run the tests

	- `npm run test:coverage`

![backend tests 93% line coverage](./assets/backend-coverage.png)

### Frontend

1. Go to frontend directory

	- `cd app/frontend`

2. Run the tests

	- `npm run test:coverage`

![frontend tests 97% line coverage](./assets/frontend-coverage.png)

## Next steps

To improve the project, I think I could work on the following subjects:

### Backend

- Create an user table

- Create a login route so user can have access just to their contacts

- Improve patch routes in order to allow user to update multiple tables at once

- Improve post routes in order to allow user to create contact, phone numbers and emails at once

- Improve test coverage

### Frontend

- Create register and login pages

- Improve style

- Display notifications about request errors

- Allow user to update and create all contact info at once

- Improve test coverage

### Other improvements

- Make docker-compose create the backend and frontend together with the database

- Deploy