{"id":20581222,"url":"https://github.com/jonathas/trainline-departures","last_synced_at":"2026-04-02T02:49:41.934Z","repository":{"id":141968540,"uuid":"112833207","full_name":"jonathas/trainline-departures","owner":"jonathas","description":" :light_rail: An API that returns the train services in order for the customers to view live departure information","archived":false,"fork":false,"pushed_at":"2017-12-02T11:04:07.000Z","size":422,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-06T12:16:25.039Z","etag":null,"topics":["api","apidoc","docker","docker-compose","es7","express","istanbul","mocha","nginx","nodejs","pm2","redis","sinon","typescript"],"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/jonathas.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-12-02T10:31:20.000Z","updated_at":"2017-12-02T11:10:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"bd8bc591-6062-49e9-9829-cd3f4ad7d290","html_url":"https://github.com/jonathas/trainline-departures","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jonathas/trainline-departures","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathas%2Ftrainline-departures","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathas%2Ftrainline-departures/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathas%2Ftrainline-departures/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathas%2Ftrainline-departures/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonathas","download_url":"https://codeload.github.com/jonathas/trainline-departures/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathas%2Ftrainline-departures/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27523841,"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","status":"online","status_checked_at":"2025-12-05T02:00:07.920Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","apidoc","docker","docker-compose","es7","express","istanbul","mocha","nginx","nodejs","pm2","redis","sinon","typescript"],"created_at":"2024-11-16T06:27:31.784Z","updated_at":"2025-12-05T16:03:57.369Z","avatar_url":"https://github.com/jonathas.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Trainline departures API\n\n## An API that returns the train services in order for the customers to view live departure information\n\n[![Build Status](https://travis-ci.org/jonathas/trainline-departures.svg?branch=master)](https://travis-ci.org/jonathas/trainline-departures) [![Coverage Status](https://coveralls.io/repos/github/jonathas/trainline-departures/badge.svg?branch=master)](https://coveralls.io/github/jonathas/trainline-departures?branch=master)\n\n![alt text](docs/trainline.jpg \"Train\")\n\n### Technologies used\n\nNode.js, ES7, TypeScript, Express, pm2, Redis, Nginx, Docker, apiDoc, mocha, sinon, istanbul.\n\n### Dependencies\n\n- Docker\n- docker-compose\n- yarn\n\n### Before anything\n\nInstall the packages and build by entering the api directory and running:\n\n```bash\nyarn \u0026\u0026 yarn build\n```\n\n### Testing the API and checking the code coverage\n\nIn order to run the tests, enter the api directory and run:\n\n```bash\nyarn test\n```\n\nAfter that, you can open api/coverage/lcov-report/index.html on your browser to check the code coverage result.\n\n### Generating the documentation for the endpoints\n\nIn order to generate the HTML with the documentation, enter the api directory and run:\n\n```bash\nyarn docs\n```\n\nAfter that, it will be available inside docs/apidoc\n\n### Developing\n\nFor developing new functionalities, you can use nodemon, pm2 or the pm2 docker image for development. If you choose the docker image, then enter the infra directory and run:\n\n```bash\ndocker-compose -f docker-dev.yml up\n```\n\nThis will start the Nginx, Redis and pm2 containers. This pm2 container is configured for reloading the code every time it is modified.\n\n### Deploying\n\nIn order to run it in production, instead of running the docker-dev.yml file, you can run the docker-compose.yml file:\n\n```bash\ndocker-compose up\n```\n\n## Further improvements\n\n- Get list of train operators, as a link wasn't given for that, and match it with the operator codes to return the real names\n- Configure log management on AWS CloudWatch\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonathas%2Ftrainline-departures","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonathas%2Ftrainline-departures","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonathas%2Ftrainline-departures/lists"}