/kennelog

Final year dissertation project

Primary LanguageTypeScriptMIT LicenseMIT

Kennelog

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Build Status Test Coverage Maintainability FOSSA Status

A journaling SPA for dog breeders.

Quick Start

To clone and run this repository, you will need to have Git, and Yarn installed and configured on your machine.

When you have setting up your machine, run these from your command line:

# clone the repository
git clone https://github.com/roris/kennelog

# go into the cloned directory
cd kennelog

# install dependencies
yarn install

# bootstrap with lerna
yarn bootstrap

# run migration scripts
NODE_ENV=development yarn migrate

# optional: seed the database
NODE_ENV=development yarn seed

# run the application (fullstack)
NODE_ENV=development yarn start

If everything goes alright, the application will be accessible through localhost:8080. You will be greeted by a familiar login form.

Testing

To start the tests, run the following from your command line from the project's root directory:

NODE_ENV=development yarn test

Built with

  • Bootstrap - Styling and frontend component library
  • Aurelia - An elegant unobtrusive frontend framework
  • Feathers - APIs without the boiler plate
  • Yarn - Package manager

License

Copyright (c) 2019

Licensed under the MIT license.