Skip to content

ATNU/hands-on-app

Repository files navigation

Hands-On App

Client for the Hands-On Reading project. Built using Angular 8 CLI.

Hands-On App

Client for the Hands-On Reading project. Built using Angular 8 CLI.

About

For a detailed project description, see this article.

Project Team

Aditi Nafde
Matt Coneys
James Cummings
Tiago Sousa Garcia

RSE Contact

Kate Court
Fiona Galston

Built With

This section is intended to list the frameworks and tools you're using to develop this software. Please link to the home page or documentatation in each case.

Angular

Getting Started

Prerequisites

Install Angualr CLI. You also need the Hands-On Reading server repo cloned and running and access to a mongodb instance.

Installation

Clone and run npm install.

Running Locally

Run npm start.

Running Tests

There are currently no tests.

Deployment

Production

The application currently deploys to Azure using a GitHub action on any push to the master branch.

Usage

Roadmap

  • Initial Research
  • Minimum viable product
  • Alpha Release
  • Feature-Complete Release

Contributing

Main Branch

Protected and can only be pushed to via pull requests. Should be considered stable and a representation of production code.

Dev Branch

Should be considered fragile, code should compile and run but features may be prone to errors.

Feature Branches

A branch per feature being worked on.

https://nvie.com/posts/a-successful-git-branching-model/

License

Citation

Please cite the associated papers for this work if you use this code:

@article{xxx2023paper,
  title={Title},
  author={Author},
  journal={arXiv},
  year={2023}
}

Acknowledgements

This work was funded by the ATNU project.