byt3sage / hc-admin

Connected Kingston - Backend

This is a Vue.js SPA (Single Page App) using Vue Router for the routing. Therefore, a good knowledge of both Vue.js and Vue Router is expected when working on this project.

This is a static site that is intended to be hosted on an amazon S3 bucket.

All logic is handled by the API - so you can think of this app as purely an interface for the API.

Installation

# Copy the example .env and fill in the empty variables.
cp .env.example .env

# Install the NPM dependencies.
npm install

Development

# Start a development server with hot-reload.
npm run serve

Test

# Run the linter and automatically fix any issues.
npm run lint --fix

# Run unit tests (no tests currently written).
npm run test:unit

# Run end-to-end tests (no tests currently written).
npm run test:e2e

Deploy

Deployment is handled automatically with CI/CD using TravisCI. Below is the commands that TraviCI uses to build the application.

npm run build

Built With

• Vue.js - The JavaScript Framework Used

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ayup Digital

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU AGPLv3 License - see the LICENSE.md file for details.