{"id":20245331,"url":"https://github.com/daaaiii/devcleanup","last_synced_at":"2026-03-07T17:01:08.611Z","repository":{"id":219203621,"uuid":"748448940","full_name":"Daaaiii/devCleanUp","owner":"Daaaiii","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-27T20:09:49.000Z","size":2648,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-03T15:34:40.737Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Daaaiii.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2024-01-26T01:39:53.000Z","updated_at":"2024-01-26T01:39:53.000Z","dependencies_parsed_at":"2024-01-27T21:23:40.077Z","dependency_job_id":"0e98c44d-86cc-484f-bea9-964e5602b5d2","html_url":"https://github.com/Daaaiii/devCleanUp","commit_stats":null,"previous_names":["daaaiii/devcleanup"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Daaaiii/devCleanUp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daaaiii%2FdevCleanUp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daaaiii%2FdevCleanUp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daaaiii%2FdevCleanUp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daaaiii%2FdevCleanUp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Daaaiii","download_url":"https://codeload.github.com/Daaaiii/devCleanUp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Daaaiii%2FdevCleanUp/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30222347,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T17:00:40.062Z","status":"ssl_error","status_checked_at":"2026-03-07T17:00:39.026Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":[],"created_at":"2024-11-14T09:20:15.706Z","updated_at":"2026-03-07T17:01:08.567Z","avatar_url":"https://github.com/Daaaiii.png","language":null,"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src='./assets/logo-devclean.png' width=\"100\" style=\"border-radius: 30%;\" alt=\"Dev Clean Up Logo\" \u003e\n\u003c/p\u003e\n\n# Dev Clean Up\n\nThis project is a small system that allows users to control their clients and check the distance from the company to their houses.\nThe main page allows the user to register and login on the system, once the user is logged in, he can cread, read, update or delete a client. \nHe also can see the distance between the company to the client's house and define a better route to get to the client based on that.\n\nThis project was developed with the following dependencies and versions:\n\n## Frontend\n\n| Dependency      | Version |\n| --------------- | ------- |\n| axios           | 1.6.5   |\n| jwt-decode      | 4.0.0   |\n| next            | 14.1.0  |\n| react           | 18      |\n| react-dom       | 18      |\n| react-hook-form | 7.49.3  |\n\n| Dev Dependency     | Version |\n| ------------------ | ------- |\n| @types/node        | 20      |\n| @types/react       | 18      |\n| @types/react-dom   | 18      |\n| autoprefixer       | 10.0.1  |\n| eslint             | 8       |\n| eslint-config-next | 14.1.0  |\n| postcss            | 8       |\n| tailwindcss        | 3.3.0   |\n| typescript         | 5       |\n\n## Backend\n\nThis is an API building with Express aiming to control clients in a system.\n\n| Dependency         | Version |\n| ------------------ | ------- |\n| bcrypt             | 5.1.1   |\n| cors               | 2.8.5   |\n| dotenv             | 16.4.1  |\n| express            | 4.18.2  |\n| jsonwebtoken       | 9.0.2   |\n| pg                 | 8.11.3  |\n| swagger-autogen    | 2.23.7  |\n| swagger-ui-express | 5.0.0   |\n\n**Dev Dependencies**\n\n| Dependency | Version |\n| ---------- | ------- |\n| nodemon    | 3.0.3   |\n## Getting Started\n\n1 - Clone the project:\n\nThe Git of the project used 2 submodules (frontend and backend) which allow to create the projects separated in other git repositories and add them together on the main repository but it also require to use additional commnand when clonning it.\n\nYou can read more about git submodules here: https://git-scm.com/book/en/v2/Git-Tools-Submodules\n\nYou can use this CLI command on your terminal:\n\n```bash\ngit clone --recurse-submodules https://github.com/Daaaiii/devCleanUp.git\n```\n\nIf you already clonned the repository without using the --recurse-submodules, you can use the command bellow to update it: \n```bash\ngit submodule update --init --recursive.\n```\n\n2 - Install the dependencies on each project separatedly:\n\n```bash\nnpm install\n# or\nyarn install\n# or\npnpm install\n# or\nbun install\n```\n\n3 - Run the development server on each project separatedly:\n\n```bash\nnpm run dev\n# or\nyarn dev\n# or\npnpm dev\n# or\nbun dev\n```\n4 - Swagger documentation of API\n The api has an script to generate Swagger automatically once the api starts.\n\nOpen [http://localhost:3001/doc](http://localhost:3001/doc) with your browser to see the documentation of the api and all the endpoints available .\n\n## The Project\n\nThe project presents a frontend and a backend. Make sure both projects are running to allow them to work together.\n\nRun each project separatedly, one at http://localhost:3000 and the other at http://localhost:3001 (backend). This will allow you to use the full project.\n1 - First create an user or log in in the system\n![Alt text](assets/login.gif)\n\n2 - Once you log at the system, you can see the clients list, edit clients, delete clients and order by id or by name.\nYou can also check the 'Distância' button that will open a page where you can see the distance between the company and the client's house.\n![Alt text](assets/clients.gif)\n\nIf you only want check the API, you can check http://localhost:3001/doc, it will open the Swagger documentation.\n![Alt text](image.png)\n\n## Stay in touch\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"https://www.linkedin.com/in/daiane-deponti-bolzan/\"\u003e\n        \u003cimg src=\"https://github.com/Daaaiii.png\" width=\"100px;\" alt=\"Foto da Dai\"/\u003e\u003cbr\u003e\n        \u003csub\u003e\n          \u003cb\u003eDaiane Bolzan\u003c/b\u003e\n        \u003c/sub\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\n## License\n\n[MIT licensed](LICENSE)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaaaiii%2Fdevcleanup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaaaiii%2Fdevcleanup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaaaiii%2Fdevcleanup/lists"}