{"id":15040685,"url":"https://github.com/learninglocker/xapi-service","last_synced_at":"2025-04-04T19:04:15.762Z","repository":{"id":25508051,"uuid":"99941517","full_name":"LearningLocker/xapi-service","owner":"LearningLocker","description":"A service for the xAPI","archived":false,"fork":false,"pushed_at":"2025-03-17T18:28:37.000Z","size":7132,"stargazers_count":40,"open_issues_count":24,"forks_count":58,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-21T17:08:56.344Z","etag":null,"topics":["nodejs","tincan","typescript","xapi"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":false,"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/LearningLocker.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":"2017-08-10T16:05:34.000Z","updated_at":"2025-01-09T07:06:56.000Z","dependencies_parsed_at":"2023-11-26T02:27:20.196Z","dependency_job_id":"e538377a-9ee8-4787-b446-5630808d67fe","html_url":"https://github.com/LearningLocker/xapi-service","commit_stats":{"total_commits":1290,"total_committers":25,"mean_commits":51.6,"dds":"0.29689922480620157","last_synced_commit":"685c342129c5e7c75d5c256c50df6874686f784b"},"previous_names":[],"tags_count":144,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LearningLocker%2Fxapi-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LearningLocker%2Fxapi-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LearningLocker%2Fxapi-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LearningLocker%2Fxapi-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LearningLocker","download_url":"https://codeload.github.com/LearningLocker/xapi-service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246076840,"owners_count":20719892,"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":["nodejs","tincan","typescript","xapi"],"created_at":"2024-09-24T20:44:55.446Z","updated_at":"2025-03-28T18:02:06.984Z","avatar_url":"https://github.com/LearningLocker.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# xAPI service\n\n![Build Status](https://github.com/LearningLocker/xapi-service/actions/workflows/integration.yml/badge.svg?branch=master)\n[![Renovate badge](https://img.shields.io/badge/Renovate-enabled-brightgreen.svg)](https://renovateapp.com/)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![Join the chat at https://gitter.im/LearningLocker/learninglocker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/LearningLocker/learninglocker?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n_Learning Locker is a trademark of [Learning Pool](http://learningpool.com)_\n\n### Development: Installation\n\nDo not use sudo for any of these installations or commands. If you're working on Learning Locker Enterprise, please make sure you've followed the [Enterprise Development Setup](https://github.com/LearningLocker/enterprise/blob/master/README.md#development-setup) first.\n\n#### Setup Repository\n\n1. Change to your Documents directory (or whichever directory you want to contain the repository) with `cd ~/Documents`.\n1. Clone the repository with `git clone git@github.com:LearningLocker/xapi-service.git`.\n1. Switch to the repository directory with `cd xapi-service`.\n1. Install dependencies with `yarn`.\n1. Copy the \".env.example\" file in the repository into a new \".env\" file.\n1. Build the code `yarn build` or `yarn build --watch` if you want to make changes.\n1. Start Mongo and Redis with `docker-compose up -d`. If you've followed the [Enterprise setup instructions](https://github.com/LearningLocker/enterprise/blob/master/README.md) already you won't need to do this.\n1. Run the server with `yarn start` or `yarn start:dev` if you want to make changes.\n\n### Development: Testing\n\nBefore you follow these instructions you may want to exit your `yarn start` command above with Ctrl + C. This ensures that the running app doesn't interfere with your testing by using Mongo and Redis.\n\n1. Install dependencies with `yarn --frozen-lockfile`.\n1. Start Mongo and Redis with `docker-compose up -d`. If you've followed the [Enterprise setup instructions](https://github.com/LearningLocker/enterprise/blob/master/README.md) already you won't need to do this.\n1. Lint the code with `yarn lint`.\n1. Build the code with `yarn build`.\n1. Test the code with `yarn test-local`.\n1. Stop the Mongo and Redis with `docker-compose down`. Use `-v` at the end to delete data.\n\n### Production: Installation\n\nTo install all of Learning Locker, see the [installation documentation](http://docs.learninglocker.net/guides-installing/). To install just the xAPI service, you can follow the instructions below.\n\n1. Clone the repository with `git clone git@github.com:LearningLocker/xapi-service.git`.\n1. Switch to the repository directory with `cd xapi-service`.\n1. Install dependencies with `yarn --frozen-lockfile`.\n1. Build the code with `yarn build`.\n1. Start the server with `yarn start`.\n\n### Docker\n\nYou can use the steps below to install and run the xAPI service.\n\n- Create a \".env\" file using the \".env.example\" file in this Github repository.\n- Pull the image from DockerHub `docker pull learninglocker/xapi-service:latest`.\n- Run the image in a container `docker run -d -p 8080:80 --env-file .env learninglocker/xapi-service:latest`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flearninglocker%2Fxapi-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flearninglocker%2Fxapi-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flearninglocker%2Fxapi-service/lists"}