https://github.com/blairg/fellrace-finder-server

API to drive fell races app
https://github.com/blairg/fellrace-finder-server

Last synced: 11 days ago
JSON representation

API to drive fell races app

• Host: GitHub
• URL: https://github.com/blairg/fellrace-finder-server
• Owner: blairg
• Created: 2018-07-05T10:36:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-12T14:03:48.000Z (11 months ago)
• Last Synced: 2023-12-12T15:28:48.119Z (11 months ago)
• Language: TypeScript
• Size: 387 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Known Vulnerabilities](https://snyk.io/test/github/blairg/fellrace-finder-server/badge.svg)](https://snyk.io/test/github/blairg/fellrace-finder-server)

# Fell Race Finder - API

This is a quick boilerplate instructing how configure TypeScript to work with Koa et al.

## To use:

1. Clone:

  `$ git clone https://github.com/blairg/fellrace-finder-server.git`

2. `yarn` install:

  `$ cd fellrace-finder-server && yarn`

  This will also install the TypeScript definitions used in this project.

3. To run the development server, run:

  `$ yarn dev-server`

  This uses `ts-node` to transpile on-the-fly and probably ain't the best idea for production.

4. To build for production, run:

  `$ yarn run build`

  ... Which can then be started with:

  `$ yarn start`

  Included is a Procfile that will do this for you on Heroku.

## ToDo:

- [ ]