https://github.com/bonnie/hiking-club-api

https://github.com/bonnie/hiking-club-api

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/bonnie/hiking-club-api
• Owner: bonnie
• License: other
• Created: 2018-03-09T18:33:47.000Z (over 7 years ago)
• Default Branch: primary
• Last Pushed: 2018-03-09T18:21:04.000Z (over 7 years ago)
• Last Synced: 2025-05-14T15:16:55.935Z (6 months ago)
• Language: JavaScript
• Size: 6.07 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

          
# Hiking Club Back End API

[![CircleCI](https://img.shields.io/circleci/project/github/mercurate-team/hiking-club-api/primary.svg?style=flat-square)](https://circleci.com/gh/mercurate-team/hiking-club-api/tree/primary)

[![Codecov](https://img.shields.io/codecov/c/github/mercurate-team/hiking-club-api/primary.svg?style=flat-square)](https://codecov.io/gh/mercurate-team/hiking-club-api)

This repo holds the back end API server for the Hiking Club web app

## Getting Started

To build and run the API you need npm and node installed, then just run the following commands:

- `npm install` to install needed modules

- `npm run db:init` to create and setup the database

- `npm run build` to transpile the ES6 source

- `npm start` to start the server!

## Running Tests

Running the test is as simple as running `npm test` after installing dependencies

Tests have been written with mocha and chai and cover each API endpoint