{"id":16099748,"url":"https://github.com/mrtimeey/word-api","last_synced_at":"2026-01-21T12:02:11.020Z","repository":{"id":42237013,"uuid":"367001265","full_name":"MrTimeey/word-api","owner":"MrTimeey","description":"An API for retrieving and saving words.","archived":false,"fork":false,"pushed_at":"2023-06-28T12:04:56.000Z","size":675,"stargazers_count":1,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T16:52:10.108Z","etag":null,"topics":["api","express","heruko","mongoose","nodejs","openapi","swagger","word-api","word-of-the-day","words"],"latest_commit_sha":null,"homepage":"https://word-of-the-day.de","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/MrTimeey.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":"2021-05-13T09:37:49.000Z","updated_at":"2022-12-23T23:23:19.000Z","dependencies_parsed_at":"2024-10-27T17:40:49.194Z","dependency_job_id":null,"html_url":"https://github.com/MrTimeey/word-api","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/MrTimeey/word-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MrTimeey%2Fword-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MrTimeey%2Fword-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MrTimeey%2Fword-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MrTimeey%2Fword-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MrTimeey","download_url":"https://codeload.github.com/MrTimeey/word-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MrTimeey%2Fword-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28632781,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","express","heruko","mongoose","nodejs","openapi","swagger","word-api","word-of-the-day","words"],"created_at":"2024-10-09T18:44:06.391Z","updated_at":"2026-01-21T12:02:11.004Z","avatar_url":"https://github.com/MrTimeey.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# word-api\n\nAn API for retrieving and saving words to build a 'word of day' application.\n\nIt's also a learning project for various technologies like nodejs, express and mongoose deployment.\n\n## Documentation\nThe API is documented with swagger/openapi. The resources will automatically mount on startup.\n\n* Integrated swagger UI: `http://localhost:8000/`.\n* Openapi.yaml: `http://localhost:8000/doc/openapi.yaml`\n* Swagger.yaml: `http://localhost:8000/doc/swagger.yaml`\n* Openapi.json: `http://localhost:8000/doc/openapi.json`\n* Swagger.json: `http://localhost:8000/doc/swagger.json`\n\n## Application env file\nCreate an .env file in `src/config` for defining the application properties\n\nExample:\n```dotenv\n# Example .env file for the application\nNODE_ENV=development\nPORT=8000\n# MongoDB\nMONGO_DB_USER=\u003cyour-mongo-db-user\u003e\nMONGO_DB_PASSWORD=\u003cyour-mongo-db-password\u003e\nMONGO_DB_HOST=\u003cyour mongo-db-host\u003e\nMONGO_DB_PORT=\u003cyour-mongo-db-port\u003e\nMONGO_DB_NAME=\u003cyour-mongo-db-name\u003e\n# Security\nAPI_KEY=\u003cyour-api-key\u003e\n```\nThe `.env.example` file is located at `src/config`.\n\n## MongoDB connection\nYou have to insert your mongoDB connection to the env file. You can use a hosted MongoDB from [mLab](https://mlab.com/) or host it yourself with provided docker-compose script.\nIf you want to use the docker-compose script, you also have to add an .env file in the mongoDB folder.\n\nExample:\n```dotenv\n# Example .env file for locally hosted MongoDB\nMONGO_DATABASE_NAME=\u003cyour-database-name\u003e\nMONGO_DATABASE_USER=\u003cyour database-user\u003e\nMONGO_PASS=\u003cyour-password\u003e\nMONGO_ROOT_PASS=\u003cyour-root-password\u003e\n```\nThe `.env.example` file is located in the mongoDB folder.\n\n## Project setup\n```\nnpm install\n```\n\n### Run tests\nWarning: First run can be really slowly\n```\nnpm run test\n```\n\n### Compiles and hot-reloads for development\n```\nnpm run serve\n```\n\n### Fix all code formatting\n```\nnpm run lint\n```\n\n## Inspiration\nUsed various sources to gather the knowledge. I listed some of them to provide you some background knowledge:\n* [REST-API](https://medium.com/@_platypus_/express-a-simple-rest-api-9d82488e829f)\n* [Environment Variables](https://medium.com/the-node-js-collection/making-your-node-js-work-everywhere-with-environment-variables-2da8cdf6e786)\n* [Testing](https://www.youtube.com/watch?v=7VNgjfmv_fE\u0026ab_channel=KrisFoster)\n* [Authorization](https://stoplight.io/blog/api-keys-best-practices-to-authenticate-apis/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrtimeey%2Fword-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrtimeey%2Fword-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrtimeey%2Fword-api/lists"}