Kelley12/horsin-around

Horse show management application

Horsin'Around

• Project Goals
• Features
• Prerequisites
• Quick Start
• Documentation
• License

Project Goals

• Long-term maintainabilty
• Extreme reliability
• Minimal dependencies
• Simple build process

Features

Feature	Summary
Backend	Node with NPM
API	API provided by Express
TypeScript	TypeScript brings you optional static type-checking along with the latest ECMAScript features.
Code Linting	TSLint provides static analysis to check TypeScript code for readability, maintainability, and functionality errors.
Frontend Framework	Vue Javascript Framework
Web App Bundler	Web application bundling using Parcel
MySQL	MySQL database used with TypeORM
Logging	Winston utilizing EventEmitter2
Auto server restart	Restart the server using nodemon in real-time anytime an edit is made
Testing	Testing using Mocha and Chai
Code Coverage	Instanbul
Continuous Integration	Continuous integration using Travis for Linux and Appveyor for Windows
Continuous Delivery	Heroku
Dependency Management	Dependencies are checked for using David
Docker	Docker used for local MySQL development

Prerequisites

• Node and NPM
• Docker and Docker Compose
• MySQL

Quick start

1. Make sure that you have Prerequisites installed.
2. Clone this repo using git clone https://github.com/kelley12/horsin-around.git
3. Move to the appropriate directory: cd horsin-around.
4. Run npm run start:dev to see the example app at http://localhost:1234.

Documentation

• Contribution Guideline
• Overview: Summary of documentation
  • .env Setup: Setting up the .env file
  • Getting Started: Getting started guide
  • CLI Commands: Commands to building, running, linting, testing, etc.
  • Debugging: Information on debugging with VS Code and Chrome
  • Docker-MySQL-PHPMyAdmin: Using Docker with MySQL and PHPMyAdmin
  • Heroku: Information on deploying to Heroku and useful Heroku CLI commands

License

This project is licensed under the MIT license, Copyright (c) 2020. For more information see LICENSE.