{"id":24312724,"url":"https://github.com/matheus1714/summary-financial-transctions-api","last_synced_at":"2025-03-09T11:09:06.217Z","repository":{"id":192497364,"uuid":"686827119","full_name":"Matheus1714/summary-financial-transctions-api","owner":"Matheus1714","description":"This is the back-end solution for the Hyperplane selection process interview.  This project is the backend that will communicate with the frontend present in the repository Summary Financial Transctions APP","archived":false,"fork":false,"pushed_at":"2023-09-05T22:13:17.000Z","size":37,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-17T08:37:37.126Z","etag":null,"topics":["api","expressjs","nodejs","postgresql","postman","vercel-deployment"],"latest_commit_sha":null,"homepage":"https://summary-financial-transctions-api.vercel.app","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/Matheus1714.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-04T02:56:49.000Z","updated_at":"2023-09-05T04:57:21.000Z","dependencies_parsed_at":"2025-01-17T08:32:07.309Z","dependency_job_id":"b93f023c-6fbd-467a-888b-555b026c9bf4","html_url":"https://github.com/Matheus1714/summary-financial-transctions-api","commit_stats":null,"previous_names":["matheus1714/summary-financial-transctions-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matheus1714%2Fsummary-financial-transctions-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matheus1714%2Fsummary-financial-transctions-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matheus1714%2Fsummary-financial-transctions-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matheus1714%2Fsummary-financial-transctions-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Matheus1714","download_url":"https://codeload.github.com/Matheus1714/summary-financial-transctions-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242679513,"owners_count":20168163,"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":["api","expressjs","nodejs","postgresql","postman","vercel-deployment"],"created_at":"2025-01-17T08:29:30.146Z","updated_at":"2025-03-09T11:09:06.196Z","avatar_url":"https://github.com/Matheus1714.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Summary Financial Transctions API 📊\r\n\r\n![GitHub](https://img.shields.io/github/license/matheus1714/summary-financial-transctions-api)\r\n![GitHub deployments](https://img.shields.io/github/deployments/matheus1714/summary-financial-transctions-api/production)\r\n\r\n## About ℹ️\r\n\r\nThis is the back-end solution for the Hyperplane selection process interview.\r\n\r\nThis project is the backend that will communicate with the frontend present in the repository [Summary Financial Transctions APP](https://github.com/Matheus1714/summary-financial-transctions-app)\r\n\r\n## Table of Content 📜\r\n\u003c!--ts--\u003e\r\n   * [About](#about-ℹ️)\r\n   * [Table of Content](#table-of-content-📜)\r\n   * [Application DEMO](#application-demo-🚀)\r\n   * [Technologies](#technologies-⚙️)\r\n   * [Features](#features-🚀)\r\n   * [Run Project](#run-project-🏃)\r\n   * [License](#license-📝)\r\n\u003c!--te--\u003e\r\n\r\n## Application DEMO 🚀\r\n\r\nBackend DEMO application can be accessed using [Back-end DEMO](https://www.postman.com/matheus1714/workspace/summary-financial-transctions-api).\r\n\r\nYou can also access the `BASE_URL`=[https://summary-financial-transctions-api.vercel.app/](https://summary-financial-transctions-api.vercel.app/).\r\n\r\n![image](https://github.com/Matheus1714/summary-financial-transctions-api/assets/39354089/262fbbff-8769-4c85-86aa-b774a7163b66)\r\n\r\n\r\n## Technologies ⚙️\r\n\r\nThe main technologies for the front-end are:\r\n\r\n* [NodeJS](https://nodejs.org/)\r\n* [Typescript](https://www.typescriptlang.org/)\r\n* [Express](https://expressjs.com/)\r\n\r\nThe main dependencies used are:\r\n\r\n```json\r\n\"devDependencies\": {\r\n   \"@rocketseat/eslint-config\": \"^2.1.0\",\r\n   \"@types/cors\": \"^2.8.14\",\r\n   \"@types/express\": \"^4.17.17\",\r\n   \"@types/http-status-codes\": \"^1.2.0\",\r\n   \"@types/node\": \"^20.4.8\",\r\n   \"@types/pg\": \"^8.10.2\",\r\n   \"@types/uuid\": \"^9.0.3\",\r\n   \"@typescript-eslint/eslint-plugin\": \"^6.6.0\",\r\n   \"eslint\": \"^8.48.0\",\r\n   \"eslint-config-standard-with-typescript\": \"^39.0.0\",\r\n   \"eslint-plugin-import\": \"^2.28.1\",\r\n   \"eslint-plugin-n\": \"^16.0.2\",\r\n   \"eslint-plugin-prettier\": \"^5.0.0\",\r\n   \"eslint-plugin-promise\": \"^6.1.1\",\r\n   \"pre-commit\": \"^1.2.2\",\r\n   \"prettier\": \"3.0.3\",\r\n   \"rimraf\": \"^5.0.1\",\r\n   \"ts-node\": \"^10.9.1\",\r\n   \"ts-node-dev\": \"^2.0.0\",\r\n   \"typescript\": \"^5.2.2\"\r\n},\r\n\"dependencies\": {\r\n   \"cors\": \"^2.8.5\",\r\n   \"dotenv\": \"^16.3.1\",\r\n   \"express\": \"^4.18.2\",\r\n   \"http-status-codes\": \"^2.2.0\",\r\n   \"nodemon\": \"^3.0.1\",\r\n   \"pg\": \"^8.11.2\",\r\n   \"uuid\": \"^9.0.0\"\r\n}\r\n```\r\n\r\n## Features 🚀\r\n\r\nAll features are for 1 year of financial transactions.\r\n\r\n* [X] `GET` spending (%) by category\r\n* [X] `GET` spending (%) by month\r\n* [X] `GET` number of transactions\r\n* [ ] `GET` visited locations by region\r\n\r\n## Run Project 🏃\r\n\r\nBefore running the project, install the dependencies:\r\n\r\n```shell\r\nnpm i\r\n```\r\n\r\nSet the environment variables:\r\n\r\nClone the `.env.example` file and make it an `.env`.\r\n\r\nThere is a configurable database present in the repository[Repo financial-data-storage](https://github.com/Matheus1714/financial-data-storage)\r\n\r\n```env\r\nPG_CONNECTION_STRING=postgres://postgres:postgres@localhost:2222/finantialdb\r\n```\r\n\r\nTo run the project, run the command:\r\n\r\n```shell\r\nnpm run dev\r\n```\r\n\r\n## License 📝\r\n\r\nThis project is open-source and is distributed under the MIT License. Feel free to explore, modify, and utilize the codebase according to the terms outlined in the license.\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatheus1714%2Fsummary-financial-transctions-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatheus1714%2Fsummary-financial-transctions-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatheus1714%2Fsummary-financial-transctions-api/lists"}