{"id":18457618,"url":"https://github.com/amwebexpert/amw-hangman-api","last_synced_at":"2026-01-23T12:55:25.228Z","repository":{"id":44413686,"uuid":"354324935","full_name":"amwebexpert/amw-hangman-api","owner":"amwebexpert","description":"Hangman REST API - NestJS implementation","archived":false,"fork":false,"pushed_at":"2022-10-29T15:47:11.000Z","size":923,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-23T10:55:09.139Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","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/amwebexpert.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}},"created_at":"2021-04-03T15:21:35.000Z","updated_at":"2022-09-03T15:44:25.000Z","dependencies_parsed_at":"2023-01-20T04:45:38.578Z","dependency_job_id":null,"html_url":"https://github.com/amwebexpert/amw-hangman-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/amwebexpert/amw-hangman-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amwebexpert%2Famw-hangman-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amwebexpert%2Famw-hangman-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amwebexpert%2Famw-hangman-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amwebexpert%2Famw-hangman-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amwebexpert","download_url":"https://codeload.github.com/amwebexpert/amw-hangman-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amwebexpert%2Famw-hangman-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28692344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T11:01:27.039Z","status":"ssl_error","status_checked_at":"2026-01-23T11:00:26.909Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":[],"created_at":"2024-11-06T08:15:03.127Z","updated_at":"2026-01-23T12:55:25.209Z","avatar_url":"https://github.com/amwebexpert.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# amw-hangman-api\n\nHangman REST API using Nest.js\n\nDeployed here: https://amw-hangman-api.herokuapp.com/\n\n## Starting the database locally\n\n    docker run --name pg-docker --rm -p 5432:5432 -e POSTGRES_PASSWORD=postgres -e POSTGRES_USER=postgres -e POSTGRES_DB=hangman -d postgres\n\nor\n\n    docker-compose up -d\n\nor simply\n\n    ./startDb.sh\n\n## Starting the REST API server locally\n\n    . ./setEnvDevWorkstation.sh\n    ./startApi.sh\n\n## Local links\n\n* http://localhost:3000 for the welcome page\n* http://localhost:3000/api/ for the API documentation\n\n\n## TODOs\n\n* add Users and link each category with a user uuid\n* whenever a category or associated text entry is created, modified or deleted, ensure the modifier is the category owner\n* create TextDto for POST and PUT input validations\n* create POST and PUT using TextDto for validations\n\n## Add categories and deploy\n\n### Adding new categories (initialData)\n\nSince we just add new collections (so far) all the DB tables can be droped and re-created:\n\n  * generate a new migration file: `typeorm migration:create src/migration/initialData`\n  * add the new array into `generateInserts.js` script and prepare the loop\n  * generate the SQL statements into `generated-data.txt` file:  `node ./tools/generateInserts.js`\n  * then copy paste results into the new file for instance `11111111111-initialData.ts`\n\n\n### Deploy Heroku repo master branch\n\n* npm install -g heroku\n* heroku --version\n* heroku login -i\n* execute `copyToHerokuStaging.sh`\n* ensure to stage new features into heroku repo here: /flutter-projects/heroku-repo/amw-hangman-api\n* git commit -m\"feat: my new features\"\n* at this point, you can `Reset Database` on `Heroku` project admin console:\n  * Resources \u003e Heroku Postgres \u003e Datastores \u003e postgresql-solid \u003e Settings\n* git push heroku master\n* heroku logs -t\n\n## Nest.js - references - licence\n\n- [Installation \u0026 Nest.js](docs/nestjs.md)\n- [References](docs/references.md)\n- [MIT licensed](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famwebexpert%2Famw-hangman-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famwebexpert%2Famw-hangman-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famwebexpert%2Famw-hangman-api/lists"}