https://github.com/fogine/bowling-api

API for bowling game. Players management, scoreboard counting.
https://github.com/fogine/bowling-api

bowling scoreboard

Last synced: 18 days ago
JSON representation

API for bowling game. Players management, scoreboard counting.

• Host: GitHub
• URL: https://github.com/fogine/bowling-api
• Owner: fogine
• License: mit
• Created: 2020-03-06T08:56:04.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-12T04:42:16.000Z (almost 2 years ago)
• Last Synced: 2024-10-06T02:21:24.351Z (about 1 month ago)
• Topics: bowling, scoreboard
• Language: JavaScript
• Homepage:
• Size: 747 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        

Service is deployed on heroku:  

- API: https://tenpin-bowling.herokuapp.com

- API Documentation: https://tenpin-bowling-docs.herokuapp.com/

Tech stack:  

- Built with [serviser framework](https://github.com/lucid-services/serviser)

- `postgres` and [knex](https://github.com/knex/knex) query builder

- data models defined with [serviser-restfulness](https://github.com/lucid-services/serviser-restfulness)

Application entrypoint: `./index.js`  

### How to run

#### localy

Make sure service configuration is valid for your environment in `config/config.js`  

You will need to set environment variables defined on top of the config file.  

Then you can start the service

> npm start

#### in docker

> docker-compose up

Run `docker container ls` to see through which ports you can access services, running inside the cointainer, on the host.

#### in docker (development mode)

* Download [serviser-docker](https://raw.githubusercontent.com/lucid-services/serviser-tools/master/serviser-docker.sh) helper script and place it in your `$PATH`.  

* Execute `serviser-docker` in the project root  

* You will be dropped into bash of ephemeral container (the container will self destruct uppon exiting the tty)  

* In there you can run:  

```bash

> npm run migrate

> npm run test:int

> npm start

```

* Project files are mirrored (mounted) into the containers fs (except `node_modules` directory) so you can edit them on your host environment.  

### Tests

> npm test