{"id":23577882,"url":"https://github.com/couchbaselabs/gameapi-nodejs","last_synced_at":"2025-10-23T18:16:40.951Z","repository":{"id":34074228,"uuid":"37870062","full_name":"couchbaselabs/gameapi-nodejs","owner":"couchbaselabs","description":"Make a simple game server API using NodeJS and Express","archived":false,"fork":false,"pushed_at":"2020-09-14T21:43:09.000Z","size":8,"stargazers_count":17,"open_issues_count":1,"forks_count":3,"subscribers_count":184,"default_branch":"master","last_synced_at":"2025-03-31T00:41:18.428Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/couchbaselabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-22T17:31:12.000Z","updated_at":"2021-10-12T12:08:55.000Z","dependencies_parsed_at":"2022-07-17T03:30:38.287Z","dependency_job_id":null,"html_url":"https://github.com/couchbaselabs/gameapi-nodejs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbaselabs%2Fgameapi-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbaselabs%2Fgameapi-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbaselabs%2Fgameapi-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbaselabs%2Fgameapi-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/couchbaselabs","download_url":"https://codeload.github.com/couchbaselabs/gameapi-nodejs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252591783,"owners_count":21773156,"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-12-26T22:31:37.618Z","updated_at":"2025-10-23T18:16:40.899Z","avatar_url":"https://github.com/couchbaselabs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Game Server API for NodeJS and Couchbase\n\n## Requirements\n\n* NodeJS\n* NPM\n* Couchbase Server\n\n## Instructions\n\nClone this repository to your desktop or any preferred location.\n\nUsing the command prompt (Windows) or Terminal (Mac / Linux) navigate to the cloned directory and run:\n\n```sh\nnpm install\n```\n\nThis will install all the required application dependencies such as the Couchbase SDK and Express framework.\n\nOpen **config.json** at the root of the project and validate that the default global configuration settings look accurate.\n\nWhen ready to test the application, using the command prompt (Windows) or Terminal (Mac / Linux), run:\n\n```\nnode app.js\n```\n\nThis will make the application accessible at http://localhost:3000\n\n## API Endpoints\n\n### POST /api/user\n\nCreate a new user account on the server\n\n#### Headers\n\nNone\n\n#### Parameters\n\n| parameter | description                        |\n|-----------|------------------------------------|\n| username  | username to access the account     |\n| password  | password for accessing the account |\n| name      | account owners name                |\n\n### GET /api/user/me\n\nGet user information about the currently signed in user\n\n#### Headers\n\n| header        | description  |\n|---------------|--------------|\n| authorization | bearer token |\n\n#### Parameters\n\nNone\n\n### GET /api/auth\n\nTrade user credentials for a session id to be used with further requests against protected endpoints\n\n#### Headers\n\nNone\n\n#### Parameters\n\n| parameter | description                        |\n|-----------|------------------------------------|\n| username  | username to access the account     |\n| password  | password for accessing the account |\n\n## Project Structure\n\n| file / folder   | parent | description                                         |\n|-----------------|--------|-----------------------------------------------------|\n| routes          | root   | all application endpoint routes will end up in here |\n| routes.js       | routes | all endpoint routes                                 |\n| models          | root   | all database classes will end up in here            |\n| accountmodel.js | models | class for crud operations on user accounts          |\n| sessionmodel.js | models | class for crud operations on user sessions          |\n| app.js          | root   | server initialization code                          |\n| config.json     | root   | server and database configuration information       |\n\n## Resources\n\n[Couchbase NodeJS API Reference](http://docs.couchbase.com/sdk-api/couchbase-node-client-2.0.8/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcouchbaselabs%2Fgameapi-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcouchbaselabs%2Fgameapi-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcouchbaselabs%2Fgameapi-nodejs/lists"}