kcapp/frontend repository overview

⁠kcapp-frontend

kcapp (pronounced keɪk æp⁠) is an application used for scoring Darts matches, with multiple input methods, statistics tracking, and more. See Wiki⁠ for more information

⁠Install

⁠Quick & Easy

To get started with development quickly, the following installer script⁠ can be used. More details can be found on the Wiki⁠

⁠Manual

1. Clone repository git clone https://github.com/kcapp/frontend.git
2. Install all nodejs dependencies npm install
3. Start the frontend by running the following command
   • Windows

     set DEBUG=kcapp:* & npm start
     

     Copy
   • Linux / OSX

     # logging to stdout
     DEBUG=kcapp:* npm start
     # or logs redirected to file
     DEBUG=kcapp:* npm start &>> "log/kcapp.log"
     

     Copy

⁠Update

1. Pull latest changes git pull
2. Install all new nodejs dependencies npm install
3. Delete .cache directory rm -rf .cache

⁠Configuration

Frontend depends on the kcapp-api⁠ for fetching data from the database.

The following environment variables can be used to adjust configuration

• NODE_ENV: specify if app should run in prod or dev mode.
  • prod will enable bundling and minifying
  • dev will start with browser-refresh⁠ for easier development
• DEBUG: value is passed to debug⁠ module to specify which packages should be logged
• KCAPP_API: by default api runs on http://localhost:8001, but this can be changed by setting it to http://<host>:<port>
• PORT : by default 3000
• DISK_CACHE: settings this will cache to disk (.cache) for optimized startup time between server runs. This folder must be deleted when a new version is deployed