{"id":19974096,"url":"https://github.com/larissaperinoto/store-manager","last_synced_at":"2026-04-11T01:08:40.523Z","repository":{"id":116558645,"uuid":"551663641","full_name":"larissaperinoto/store-manager","owner":"larissaperinoto","description":"Project Store Manager is a RESTful API for managing a store's system.","archived":false,"fork":false,"pushed_at":"2022-12-30T15:01:58.000Z","size":307,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-12T09:32:20.546Z","etag":null,"topics":["chai","express","javascript","mocha","mysql","nodejs","sql","swagger"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/larissaperinoto.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-14T21:01:21.000Z","updated_at":"2024-08-19T10:02:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"7198dfd0-5bad-4d10-9dd7-45cb9e33cce4","html_url":"https://github.com/larissaperinoto/store-manager","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/larissaperinoto%2Fstore-manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/larissaperinoto%2Fstore-manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/larissaperinoto%2Fstore-manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/larissaperinoto%2Fstore-manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/larissaperinoto","download_url":"https://codeload.github.com/larissaperinoto/store-manager/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241406666,"owners_count":19958019,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["chai","express","javascript","mocha","mysql","nodejs","sql","swagger"],"created_at":"2024-11-13T03:13:54.089Z","updated_at":"2026-04-11T01:08:40.469Z","avatar_url":"https://github.com/larissaperinoto.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Store manager\n\n[Trybe](https://www.betrybe.com/) is a technology school focused on training Web Developers and the Store Manager project was proposed as an activity to improve studies on back-end development.\n\n## Description\n\nThe developed application is a sales management system where it should be possible to create, update, read and delete products and sales.\n\n## Technologies and Tools\n\u003cdiv\u003e\n    \u003cimg src=\"https://img.shields.io/badge/MySQL-005C84?style=for-the-badge\u0026logo=mysql\u0026logoColor=white\" alt=\"mysql\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Node.js-339933?style=for-the-badge\u0026logo=nodedotjs\u0026logoColor=white\" alt=\"nodejs\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge\u0026logo=docker\u0026logoColor=white\" alt=\"docker\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Express.js-000000?style=for-the-badge\u0026logo=express\u0026logoColor=white\" alt=\"express\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Mocha-8D6748?style=for-the-badge\u0026logo=Mocha\u0026logoColor=white\" alt=\"mocha\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Swagger-85EA2D?style=for-the-badge\u0026logo=Swagger\u0026logoColor=white\" alt=\"Swagger\"/\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\nThe elaboration of the RESTful API used the **Model-Service-Controller(MSC)** architecture, in addition to the following tools:\n\n- [Node.JS](https://nodejs.org/en/)\n- [Express](https://expressjs.com/pt-br/)\n- [MySQL](https://www.mysql.com/)\n- [Docker](https://www.docker.com/)\n\nIn the development of unit tests was used:\n\n- [Mocha](https://mochajs.org/)\n- [Chai](https://www.chaijs.com/)\n- [Sinon](https://sinonjs.org/)\n\n**Note**: The SQL scripts _migration.sql_ and _seed.sql_ for creating the *StoreManager* database were provided by [Trybe](https://www.betrybe.com/).\n\n## ⚙️ How to use\n\nTo run the application, start by making a clone of this repository with the command below.\n\n    git clone git@github.com:larissaperinoto/store-manager.git\n\nNavigate to the project root.\n\n    cd store-manager/\n    \n\u003cdetails\u003e\n   \u003csummary\u003e\u003cstrong\u003eRunning locally\u003c/strong\u003e\u003c/summary\u003e \n  \u003c/br\u003e\n  \n  \u003cstrong\u003eObs:\u003c/strong\u003e To run the application this way you must have [Node](https://nodejs.org/en/) installed on your machine.\n \n  In the root of the project run the command below to install the dependencies.\n\n    npm install\n\n To upload the server with \u003cstrong\u003enodemon\u003c/strong\u003e use the command below in the terminal of the \u003cstrong\u003estore_manager\u003c/strong\u003e container.\n    \n    npm run debug\n    \n Login to the database using your credentials.\n \n    mysql -u \u003cyour-username\u003e -p\n \n Run the \u003cstrong\u003emigration.sql\u003c/strong\u003e and \u003cstrong\u003eseed.sql\u003c/strong\u003e scripts to create the \u003cstrong\u003eStore Manager\u003c/strong\u003e database.\n\n Now we can run the tests using the command below.\n  \n    npm run test:mocha\n    \n\u003c/details\u003e\n    \n\u003cdetails\u003e\n   \u003csummary\u003e\u003cstrong\u003eRunning with Docker\u003c/strong\u003e\u003c/summary\u003e \n  \u003c/br\u003e\n  \n  \u003cstrong\u003eObs.:\u003c/strong\u003e To run the application this way you must have [Docker](https://www.docker.com/) installed on your machine.\n  \n In the root of the project, upload the \u003cstrong\u003estore_manager\u003c/strong\u003e and \u003cstrong\u003estore_manager_db\u003c/strong\u003e containers using docker-compose.\n\n    docker-compose up -d\n    \n  Open the \u003cstrong\u003estore_manager\u003c/strong\u003e container terminal.\n\n     docker exec -it store_manager bash\n\n Once in the container terminal, run the command below to install the dependencies.\n\n    npm install\n    \n To start the server with \u003cstrong\u003enodemon\u003c/strong\u003e use the command bellow in the terminal of the \u003cstrong\u003estore_manager\u003c/strong\u003e container.\n    \n    npm run debug\n    \n To connect with database, open the \u003cstrong\u003estore_manager_db\u003c/strong\u003e container terminal.\n  \n    docker exec -it store_manager_db bash\n    \n Login to the database using the credentials described in the \u003cstrong\u003edocker-compose.yaml\u003c/strong\u003e.\n \n    mysql -u root -p\n \n Run the \u003cstrong\u003emigration.sql\u003c/strong\u003e and \u003cstrong\u003eseed.sql\u003c/strong\u003e scripts to create the \u003cstrong\u003eStore Manager\u003c/strong\u003e database.\n\n We can run all tests using the command bellow in the terminal of the \u003cstrong\u003estore_manager\u003c/strong\u003e container.\n  \n    npm run test:mocha\n    \n\u003c/details\u003e\n\n## Routes\n\n You can check all the routes by accessing the /docs endpoint in your browser when running the application.\n\n\u003cdetails\u003e\n    \u003csummary\u003eRoutes preview\u003c/summary\u003e\n    \n![Captura de tela de 2022-12-30 11-23-11](https://user-images.githubusercontent.com/98956659/210083904-17a7e8db-bf09-4f7f-9dc4-8f1cf06a05c2.png)\n\n    \n\u003c/details\u003e\n    \n---\n \nDeveloped by [Larissa Perinoto](www.linkedin.com/in/larissaperinoto), © 2022.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flarissaperinoto%2Fstore-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flarissaperinoto%2Fstore-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flarissaperinoto%2Fstore-manager/lists"}