{"id":15825885,"url":"https://github.com/eliasgcf/pontoloc-api","last_synced_at":"2025-05-08T22:42:10.678Z","repository":{"id":47006425,"uuid":"260976350","full_name":"EliasGcf/pontoloc-api","owner":"EliasGcf","description":"🛠  Rest api for pontoloc application - made with express framework - using docker, postgreSQL and typeORM","archived":false,"fork":false,"pushed_at":"2021-09-17T16:11:20.000Z","size":552,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-08T22:42:05.006Z","etag":null,"topics":["backend","docker","docker-compose","express","nodejs","postgresql"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/EliasGcf.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}},"created_at":"2020-05-03T16:48:15.000Z","updated_at":"2023-03-07T16:00:03.000Z","dependencies_parsed_at":"2022-09-02T22:24:04.511Z","dependency_job_id":null,"html_url":"https://github.com/EliasGcf/pontoloc-api","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/EliasGcf%2Fpontoloc-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EliasGcf%2Fpontoloc-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EliasGcf%2Fpontoloc-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EliasGcf%2Fpontoloc-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EliasGcf","download_url":"https://codeload.github.com/EliasGcf/pontoloc-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253160727,"owners_count":21863624,"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":["backend","docker","docker-compose","express","nodejs","postgresql"],"created_at":"2024-10-05T09:23:38.658Z","updated_at":"2025-05-08T22:42:10.660Z","avatar_url":"https://github.com/EliasGcf.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg\n    alt=\"Logo\"\n    src=\"https://res.cloudinary.com/eliasgcf/image/upload/v1588529377/pontoloc/logo_hmpbwn.png\" width=\"300px\"\n  /\u003e\n\u003c/h1\u003e\n\n\u003ch3 align=\"center\"\u003e\n  Express Application for a PontoLoc Web App\n\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"GitHub top language\" src=\"https://img.shields.io/github/languages/top/EliasGcf/pontoloc-api?color=%23fbc131\"\u003e\n\n  \u003ca href=\"https://www.linkedin.com/in/eliasgcf/\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg alt=\"Made by\" src=\"https://img.shields.io/badge/made%20by-elias%20gabriel-%23fbc131\"\u003e\n  \u003c/a\u003e\n\n  \u003cimg alt=\"Repository size\" src=\"https://img.shields.io/github/repo-size/EliasGcf/pontoloc-api?color=%23fbc131\"\u003e\n\n  \u003ca href=\"https://github.com/EliasGcf/pontoloc-api/commits/master\"\u003e\n    \u003cimg alt=\"GitHub last commit\" src=\"https://img.shields.io/github/last-commit/EliasGcf/pontoloc-api?color=%23fbc131\"\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/EliasGcf/pontoloc-api/issues\"\u003e\n    \u003cimg alt=\"Repository issues\" src=\"https://img.shields.io/github/issues/EliasGcf/pontoloc-api?color=%23fbc131\"\u003e\n  \u003c/a\u003e\n\n  \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/EliasGcf/pontoloc-api?color=%23fbc131\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#-about-the-project\"\u003eAbout the project\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-technologies\"\u003eTechnologies\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-getting-started\"\u003eGetting started\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-how-to-contribute\"\u003eHow to contribute\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-license\"\u003eLicense\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp id=\"insomniaButton\" align=\"center\"\u003e\n  \u003ca href=\"https://insomnia.rest/run/?label=PontoLoc\u0026uri=https%3A%2F%2Fraw.githubusercontent.com%2FEliasGcf%2Fpontoloc-api%2Fmaster%2FInsomnia.json\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://insomnia.rest/images/run.svg\" alt=\"Run in Insomnia\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## 👨🏻‍💻 About the project\n\nPontoLoc is a micro enterprise that rents construction materials. Thinking about helping them, I developed this API so the company can have a simple and easy way to control and visualize the rent of its materials.\n\nThe company can create lists and contracts of clients, lists of materials with their respective quantities, delivery and collection fee and calculate the final price when the rental period is end.\n\nTo see the **web client**, click here: [PontoLoc Web](https://github.com/EliasGcf/pontoloc-web)\u003cbr /\u003e\n\n## 🚀 Technologies\n\nTechnologies that I used to develop this api\n\n- [Node.js](https://nodejs.org/en/)\n- [TypeScript](https://www.typescriptlang.org/)\n- [Express](https://expressjs.com/pt-br/)\n- [TypeORM](https://typeorm.io/#/)\n- [JWT-token](https://jwt.io/)\n- [Celebrate](https://github.com/arb/celebrate)\n- [PostgreSQL](https://www.postgresql.org/)\n- [Date-fns](https://date-fns.org/)\n- [Jest](https://jestjs.io/)\n- [SuperTest](https://github.com/visionmedia/supertest)\n- [Husky](https://github.com/typicode/husky)\n- [Commitlint](https://github.com/conventional-changelog/commitlint)\n- [Commitizen](https://github.com/commitizen/cz-cli)\n- [Eslint](https://eslint.org/)\n- [Prettier](https://prettier.io/)\n- [EditorConfig](https://editorconfig.org/)\n\n## 💻 Getting started\n\nImport the `Insomnia.json` on Insomnia App or click on [Run in Insomnia](#insomniaButton) button\n\n### Requirements\n\n- [Docker](https://www.docker.com/)\n- [Docker Compose](https://docs.docker.com/compose/)\n\n**Clone the project and access the folder**\n\n```bash\n$ git clone https://github.com/EliasGcf/pontoloc-api.git \u0026\u0026 cd pontoloc-api\n```\n\n**Follow the steps below**\n\n```bash\n# Install the dependencies\n$ yarn\n\n# Make a copy of '.env.example' to '.env'\n# and set with YOUR environment variables\n$ cp .env.example .env\n\n# Run the services\n$ docker-compose up -d\n\n# Once the services are running, run the migrations\n$ yarn typeorm migration:run\n\n# For make requests you must use JWT Token\n# So, run the seeds to create admin user\n$ yarn seed:run\n\n# Credentials:\n# email: admin@pontoloc.com.br\n# password: 123456\n\n# Well done, project is started!\n```\n\n## 🤔 How to contribute\n\n- **Make a fork of this repository**\n\n```bash\n# Fork using GitHub official command line\n# If you don't have the GitHub CLI, use the web site to do that.\n\n$ gh repo fork EliasGcf/pontoloc-api\n```\n\n```bash\n# Clone your fork\n$ git clone your-fork-url \u0026\u0026 cd pontoloc-api\n\n# Create a branch with your feature\n$ git checkout -b my-feature\n\n# Make the commit with your changes\n$ git commit -m 'feat: My new feature'\n\n# Send the code to your remote branch\n$ git push origin my-feature\n```\n\nAfter your pull request is merged, you can delete your branch\n\n## 📝 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\nMade with 💜 by Elias Gabriel 👋 [See my linkedin](https://www.linkedin.com/in/eliasgcf/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feliasgcf%2Fpontoloc-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feliasgcf%2Fpontoloc-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feliasgcf%2Fpontoloc-api/lists"}