{"id":25132101,"url":"https://github.com/braien-machado/contact-list","last_synced_at":"2026-04-08T16:32:26.067Z","repository":{"id":45406599,"uuid":"513619385","full_name":"braien-machado/contact-list","owner":"braien-machado","description":null,"archived":false,"fork":false,"pushed_at":"2022-07-18T21:51:35.000Z","size":3611,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-17T04:35:55.929Z","etag":null,"topics":["jest","mocha-chai","nodejs","prisma","react","sinon","styled-components","testing-library","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/braien-machado.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-13T17:50:26.000Z","updated_at":"2022-07-19T12:23:36.000Z","dependencies_parsed_at":"2022-09-11T02:02:03.654Z","dependency_job_id":null,"html_url":"https://github.com/braien-machado/contact-list","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/braien-machado/contact-list","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braien-machado%2Fcontact-list","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braien-machado%2Fcontact-list/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braien-machado%2Fcontact-list/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braien-machado%2Fcontact-list/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/braien-machado","download_url":"https://codeload.github.com/braien-machado/contact-list/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braien-machado%2Fcontact-list/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31564900,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jest","mocha-chai","nodejs","prisma","react","sinon","styled-components","testing-library","typescript"],"created_at":"2025-02-08T14:16:46.897Z","updated_at":"2026-04-08T16:32:26.051Z","avatar_url":"https://github.com/braien-machado.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n# Contact List\nThis project is a simple contact list built from scratch.\n\n![contact name interaction demo](./assets/contact-list-gif1)\n![contact phone interaction demo](./assets/contact-list-gif2)\n![contact email interaction demo](./assets/contact-list-gif3)\n\n## Sumary\n- [Description](#contact-list)\n- [Technologies](#technologies)\n- [Getting started](#getting-started)\n- [Tests coverage](#tests-coverage)\n- [Next steps](#next-steps)\n\n## Technologies\n- Backend:\n\t- Typescript\n\t- Node.js\n\t- MySQL\n\t- Prisma ORM\n\t- Tests: Mocha, Chai, Sinon\n- Frontend\n\t- Typescript\n\t- React\n\t- Tests: Jest,  React Testing Library\n\n## Getting Started\n1. Clone the repository\n\t-  `git clone git@github.com:braien-machado/contact-list.git`\n\n 2. Go to the cloned repository\n\t-  `cd contact-list`\n\n2.   Install the dependencies\n\t\t- `npm install`\n\n4. Build the mySQL database with *docker-compose*\n\t- `npm run compose:up`\n\t- Obs: If you get a timeout error in the first time running compose:up, remove the container and run the command again.\n5. 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\n6. Go to backend directory and start the api\n\t-  `cd app/backend \u0026\u0026 npm start`\n\t- 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\n7. Open another terminal, go to frontend directory and start the app\n\t-  `cd app/frontend \u0026\u0026 npm start`\n8. If the app do not open automatically, search for http://localhost:3000/ in any browser\n\n## Tests coverage\n### Backend\n1. Go to backend directory\n\t- `cd app/backend`\n2. Run the tests\n\t- `npm run test:coverage`\n\n![backend tests 93% line coverage](./assets/backend-coverage.png)\n\n### Frontend\n1. Go to frontend directory\n\t- `cd app/frontend`\n2. Run the tests\n\t- `npm run test:coverage`\n\n![frontend tests 97% line coverage](./assets/frontend-coverage.png)\n\n## Next steps\nTo improve the project, I think I could work on the following subjects:\n### Backend\n- Create an user table\n- Create a login route so user can have access just to their contacts\n- Improve patch routes in order to allow user to update multiple tables at once\n- Improve post routes in order to allow user to create contact, phone numbers and emails at once\n- Improve test coverage\n### Frontend\n- Create register and login pages\n- Improve style\n- Display notifications about request errors\n- Allow user to update and create all contact info at once\n- Improve test coverage\n\n### Other improvements\n- Make docker-compose create the backend and frontend together with the database\n- Deploy\n\n\t\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbraien-machado%2Fcontact-list","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbraien-machado%2Fcontact-list","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbraien-machado%2Fcontact-list/lists"}