{"id":15793268,"url":"https://github.com/julianpasquale/vibrations-api","last_synced_at":"2025-03-31T19:21:12.869Z","repository":{"id":128984928,"uuid":"319425221","full_name":"JulianPasquale/vibrations-api","owner":"JulianPasquale","description":null,"archived":false,"fork":false,"pushed_at":"2021-06-12T16:02:52.000Z","size":295,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-11T23:33:07.704Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/JulianPasquale.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2020-12-07T19:39:20.000Z","updated_at":"2021-06-12T16:02:54.000Z","dependencies_parsed_at":"2023-04-03T18:33:55.842Z","dependency_job_id":null,"html_url":"https://github.com/JulianPasquale/vibrations-api","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JulianPasquale%2Fvibrations-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JulianPasquale%2Fvibrations-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JulianPasquale%2Fvibrations-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JulianPasquale%2Fvibrations-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JulianPasquale","download_url":"https://codeload.github.com/JulianPasquale/vibrations-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246523767,"owners_count":20791446,"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-04T23:10:23.153Z","updated_at":"2025-03-31T19:21:12.842Z","avatar_url":"https://github.com/JulianPasquale.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vibrations API\n\n# Versi贸n en espa帽ol 馃嚘馃嚪\n\nServicio backend creado para el trabajo de la tesina de Licenciatura en sistemas de Julian Pasquale.\nEste servicio se encagar de almacenar y retornar vibraciones a traves de una JSON API.\n\nLos endpoints que esta app expone son consumidos actualmente por un [servicio frontend](https://github.com/JulianPasquale/haptic-design-UI), basado en ReactJS, creado para el mismo prop贸sito.\n\nLos datos se almacenan en una base de datos NoSQL proporcionada por el servicio [Firebase Firestore](https://firebase.google.com/docs/firestore). 馃毃 Para poder acceder a estos datos localmente, deber谩 tener a su disposici贸n credenciales de Google cloud Platform 馃毃.\n\nTodos los endpoints son p煤blicos, es decir que no es necesario iniciar sesi贸n.\n\n## Prerrequisitos\n- [node](https://nodejs.org/es/download/) ~14.15.0\n- [yarn](https://classic.yarnpkg.com/en/docs/install) ~1.22.0\n- Archivo JSON con las credenciales de Google.\n\n## C贸mo empezar\n\n1. Clonar el repositorio:\n```bash\n# Usando ssh\ngit clone git@github.com:JulianPasquale/vibrations-api.git\n\n# Usando https\ngit clone https://github.com/JulianPasquale/vibrations-api.git\n```\n2. Instalar las dependencias\n```bash\nyarn install\n```\n3. Crear archivo `.env` en la ra铆z del proyecto, para configurar las variables de entorno con el siguiente contenido:\n```\nPORT=3000\nGOOGLE_APPLICATION_CREDENTIALS=path/to/google-access.json\n```\n4. Correr el servidor\n```bash\nyarn build\nyarn start\n\n# Para que el c贸digo se actualice cada vez que un archivo es modificado,\n# se puede utilizar este comando en lugar de los anteriores.\nyarn watch\n```\n\n## URLs p煤blicas\n\nEste servicio est谩 publicado en Heroku, usando la versi贸n gratuita, por lo que la primer petici贸n puede demorar algunos segundos.\n- [Entorno de desarrollo](https://vibrations-api.herokuapp.com/)\n- [Entorno de producci贸n](https://vibrations-api-production.herokuapp.com/)\n\n## Endpoints\nSe puede ver una documentaci贸n completa de todos los endpoints [aqu铆](https://documenter.getpostman.com/view/5808957/TzY1iwof), incluyendo ejempos de peticiones y respuestas. Tambien puede descargarse una colecci贸n de Postman del mismo sitio.\n\n\n# English version 馃嚭馃嚫 馃彺鬆仹鬆仮鬆仴鬆伄鬆仹鬆伩\n\nBackend service created for Julian Pasquale's Bachelor of Systems thesis work.\n\nThis service is in charge of storing and returning vibrations through a JSON API. The endpoints that this app exposes are currently consumed by a [frontend service](https://github.com/JulianPasquale/haptic-design-UI), created with ReactJS for the same purpose.\n\nData is stored in a NoSQL database provided by [Firebase Firestore](https://firebase.google.com/docs/firestore) service. 馃毃 To be able to access to this data locally, you'll need to have GCP credentials 馃毃.\n\nAll endpoints are public - no sign in required\n## Prerequisites\n- [node](https://nodejs.org/es/download/) ~14.15.0\n- [yarn](https://classic.yarnpkg.com/en/docs/install) ~1.22.0\n- JSON file with Google credentials.\n\n## Getting started\n\n1. Clone the repository:\n```bash\n# Using ssh\ngit clone git@github.com:JulianPasquale/vibrations-api.git\n\n# Using https\ngit clone https://github.com/JulianPasquale/vibrations-api.git\n```\n2. Install dependencies\n```bash\nyarn install\n```\n3. Create a `.env` file to setup your environment variables at the root of the project and put this content inside:\n```\nPORT=3000\nGOOGLE_APPLICATION_CREDENTIALS=path/to/google-access.json\n```\n4. Start the server\n```bash\nyarn build\nyarn start\n\n# Or if you want to have live-reloading on your code.\n# You can also skip the build step\nyarn watch\n```\n\n## Public URLs\n\nThis service is published in Heroku, using free dynos - first request can take some time to respond.\n- [Development environment](https://vibrations-api.herokuapp.com/)\n- [Production environment](https://vibrations-api-production.herokuapp.com/)\n\n## Endpoints\nYou can see a full documentation, with requests and responses examples [here](https://documenter.getpostman.com/view/5808957/TzY1iwof). You can also download a Postman collection from there.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjulianpasquale%2Fvibrations-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjulianpasquale%2Fvibrations-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjulianpasquale%2Fvibrations-api/lists"}