{"id":20812133,"url":"https://github.com/eugene-matvejev/node-battleship","last_synced_at":"2026-04-10T06:55:57.492Z","repository":{"id":42338335,"uuid":"179564089","full_name":"eugene-matvejev/node-battleship","owner":"eugene-matvejev","description":"backend for https://github.com/eugene-matvejev/react-battleship","archived":false,"fork":false,"pushed_at":"2023-01-04T04:23:51.000Z","size":2344,"stargazers_count":1,"open_issues_count":23,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-12T04:45:01.013Z","etag":null,"topics":["apollo-server","docker","express","graphql","javascript","jest","sequlize"],"latest_commit_sha":null,"homepage":"","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/eugene-matvejev.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":"2019-04-04T19:31:28.000Z","updated_at":"2019-07-22T13:52:20.000Z","dependencies_parsed_at":"2023-02-01T20:02:04.423Z","dependency_job_id":null,"html_url":"https://github.com/eugene-matvejev/node-battleship","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eugene-matvejev/node-battleship","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugene-matvejev%2Fnode-battleship","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugene-matvejev%2Fnode-battleship/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugene-matvejev%2Fnode-battleship/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugene-matvejev%2Fnode-battleship/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eugene-matvejev","download_url":"https://codeload.github.com/eugene-matvejev/node-battleship/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugene-matvejev%2Fnode-battleship/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269842017,"owners_count":24483970,"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-08-11T02:00:10.019Z","response_time":75,"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":["apollo-server","docker","express","graphql","javascript","jest","sequlize"],"created_at":"2024-11-17T20:50:39.483Z","updated_at":"2025-12-30T21:47:40.229Z","avatar_url":"https://github.com/eugene-matvejev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[ci.tests-master-badge]: https://circleci.com/gh/eugene-matvejev/node-battleship/tree/master.svg?style=svg\n[ci.tests-master]: https://circleci.com/gh/eugene-matvejev/node-battleship/tree/master\n[ci.coverage-master-badge]: https://codecov.io/gh/eugene-matvejev/node-battleship/branch/master/graph/badge.svg\n[ci.coverage-master]: https://codecov.io/gh/eugene-matvejev/node-battleship/branch/master\n\n[ci.tests-heroku-badge]: https://circleci.com/gh/eugene-matvejev/node-battleship/tree/heroku.svg?style=svg\n[ci.tests-heroku]: https://circleci.com/gh/eugene-matvejev/node-battleship/tree/heroku\n[ci.coverage-heroku-badge]: https://codecov.io/gh/eugene-matvejev/node-battleship/branch/heroku/graph/badge.svg\n[ci.coverage-heroku]: https://codecov.io/gh/eugene-matvejev/node-battleship/branch/heroku\n\n|               | master                                                        | heroku\n|---            |---                                                            | ---\n| __tests__     | [![tests][ci.tests-master-badge]][ci.tests-master]            | [![tests][ci.tests-heroku-badge]][ci.tests-heroku]\n| __coverage__  | [![coverage][ci.coverage-master-badge]][ci.coverage-master]   | [![coverage][ci.coverage-heroku-badge]][ci.coverage-heroku]\n\n# battleship GraphQL backend\n\n##### THIS IS SPARE TIME PROJECT, WORK IN PROGRESS!\n\n### software requirements\n\nif you're using `make` commands, __[docker](https://docs.docker.com/install/)__ and __[docker-compose](https://docs.docker.com/compose/install/)__ are required, and local __[node.js](https://nodejs.org/)__ with __[npm](https://www.npmjs.com/)__ are optional\n* [node.js](https://nodejs.org/) v10+\n* [npm](https://www.npmjs.com/) v6+ or [yarn](https://yarnpkg.com/)\n* __optional__ [makefile](https://en.wikipedia.org/wiki/Makefile) comes out of the box in *unix* enviroments\n* __optional__ [docker](https://www.docker.com/) v18.09+\n* __optional__ [sqlite3](https://www.sqlite.org/index.html) v3+ *for 'integration' tests only*\n\n### used technologies\n\n* [apollo server](https://www.apollographql.com/docs/apollo-server/)\n* [express.js](https://expressjs.com/)\n* [sequlize](http://docs.sequelizejs.com/)\n* [graphql](https://graphql.org/)\n* [jest](https://facebook.github.io/jest/)\n\n### used services\n\n* [circle ci](https://circleci.com/dashboard)\n* [codecov](https://codecov.io/)\n* [code climate](https://codeclimate.com/)\n* [snyk](https://snyk.io/)\n* [heroku](https://www.heroku.com/)\n\n### how to install\n\n* with `make` commands no steps additional required, otherwise you need execute `$ npm i`\n\n### how to run tests\n\n* `$ make test` or `$ npm test`\n  * __optional__ [ 'jest' CLI params](https://facebook.github.io/jest/docs/en/cli.html) some examples:\n    * to generate coverage report, example: `$ npm test -- --coverage`, which will be located in __./coverage__ directory\n    * to execute tests __only__ in specific file, example: `$ npm test src/graphql/user.test.js`\n\n### how to run in 'development' mode\n\n* `$ make` or `$ npm start`\n\n### how to run in 'production' mode\n\n* `$ make serve`, there is no *npm* equivalent\n* if you __only__ need to generate static assets\n  * `$ make build` or `$ npm run build` - generated assets will be located in __./build__ directory\n\n### gitflow\n\n* master -\u003e most up-to-date __production__ version\n* __proxy branch__ heroku -\u003e master is not deployed to heroku with every push, because of limitations of 'free account'\n* other branches -\u003e 'feature branches' get merged into master\nCI build is a mandatory check for every PR into master/heroku branches\n\n### used environment variables\n\n| variable      | default value | used as\n|---            |---            |---\n| PORT          | 8081          | number\n| DB_HOSTNAME   | 127.0.0.1     | string\n| DB_USERNAME   | root          | string\n| DB_PASSWORD   | password      | string\n| DB_PORT       | 3306          | number\n| DB_NAME       | battleship    | string\n| DB_DIALECT    | mysql         | string\n| SECRET_KEY    | local.key     | string\n\n### supported databases\n| database      | version\n|---            |---\n| MySQL         | *5.7 tested*, using [mysql2](https://www.npmjs.com/package/mysql2)\n| PostgreSQL    | *11 tested*, using [pg](https://www.npmjs.com/package/pg)\n| SQLite        | *4.0.9 tested*, using [sqlite3](https://www.npmjs.com/package/sqlite3)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feugene-matvejev%2Fnode-battleship","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feugene-matvejev%2Fnode-battleship","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feugene-matvejev%2Fnode-battleship/lists"}