{"id":15562923,"url":"https://github.com/matsoftware/mobile-metrics-api","last_synced_at":"2025-03-29T05:11:26.486Z","repository":{"id":90665715,"uuid":"298862147","full_name":"matsoftware/mobile-metrics-api","owner":"matsoftware","description":"Backend system for storing mobile metrics data","archived":false,"fork":false,"pushed_at":"2021-01-22T16:14:17.000Z","size":1233,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-03T14:47:23.956Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/matsoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"liberapay":"matsoftware"}},"created_at":"2020-09-26T17:09:37.000Z","updated_at":"2021-01-22T16:14:20.000Z","dependencies_parsed_at":"2023-07-09T04:00:26.957Z","dependency_job_id":null,"html_url":"https://github.com/matsoftware/mobile-metrics-api","commit_stats":{"total_commits":7,"total_committers":3,"mean_commits":"2.3333333333333335","dds":0.4285714285714286,"last_synced_commit":"829d79e67f612b62b5293b27b53936ef4814ddb2"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matsoftware%2Fmobile-metrics-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matsoftware%2Fmobile-metrics-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matsoftware%2Fmobile-metrics-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matsoftware%2Fmobile-metrics-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matsoftware","download_url":"https://codeload.github.com/matsoftware/mobile-metrics-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246140588,"owners_count":20729802,"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":[],"created_at":"2024-10-02T16:16:47.286Z","updated_at":"2025-03-29T05:11:26.461Z","avatar_url":"https://github.com/matsoftware.png","language":"JavaScript","readme":"# mobile-metrics-api\n\nBootstrap for a CRUD backend system targeted at persisting [mobile apps metrics](https://github.com/matsoftware/mobile-metrics).\n\nThe REST API backend has been developed using **Node JS 12 LTS** using **MS SQL** as default database (to comply with most of the corporates requirements). \n\nYou can change the SQL configuration in [api/app/config/db.config.js](api/app/config/db.config.js).\n\n## Pre-requisites\n\n1. Make sure you have [Node](https://nodejs.org/en/download/) installed\n\n2. Install DB engines:\n    - **MS SQL**: install SQL Server using Docker on Unix: https://docs.microsoft.com/en-us/sql/linux/quickstart-install-connect-docker?view=sql-server-linux-2017\u0026pivots=cs1-bash and [Azure Data Studio](https://github.com/microsoft/azuredatastudio/releases/tag/1.21.0) to connect directly to the database\n    - **SQLite**: no actions needed (Mac OS)\n\n3. Create a `.env` file in the `api` folder with the local database settings:\n    - **MS SQL**:\n    ```bash\n    DB_HOST=localhost\n    DB_USER=sa\n    DB_PASS=YourStrong@Passw0rd1\n    DB_PORT=1401\n    DB_DIALECT=mssql\n    PORT=3000\n    ```\n    - **SQLite**:\n    ```bash\n    DB_HOST=localhost\n    DB_USER=root\n    DB_PASS=root\n    DB_PORT=1401\n    DB_STORAGE=mobile_metrics.sqlite\n    DB_DIALECT=sqlite\n    PORT=3000\n    ```\n\n4. Install the dependencies by running `./yarn install`; for true offline installations, please update the `.gitignore` file to persist the downloaded binaries\n\n5. Run the server locally with `npm run debug`\n\n     To kill existing open instances of the server do:\n    ```bash\n    sudo lsof -i :3000\n    kill -9 \u003cPID\u003e\n    ```\n\n    The project is structured to be easily debugged using VS Code with a preconfigured launch command\n\n6. Add a new `User` entry to the `users` table in the database with the `token` that will be matched against the `X-API-Token` value of the API requests\n\n7. Test the APIs using this Postman collection:\n\n    [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/d0dbb85e24c41bbcfa42)\n\n## Development\n\nIn order to update dependencies, please make sure check your [Yarn offline](https://classic.yarnpkg.com/blog/2016/11/24/offline-mirror/) configuration.","funding_links":["https://liberapay.com/matsoftware"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatsoftware%2Fmobile-metrics-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatsoftware%2Fmobile-metrics-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatsoftware%2Fmobile-metrics-api/lists"}