Note: This repository is a work-in-progress. All work done so far is preliminary and subject to change.
This repository aims to combine all Laixer frontend applications into a single monorepo. Currently, each project is maintained separately, which promotes code duplication and decreases time efficiency for implementing new features.
For more info, please visit the appropriate section in this README. If you wish to see what is currently being worked on, please visit the project page.
Please see the references below for an overview of information.
Setup for development - Step-by-step guideline on how to set up a development environment.
Project information - For information about the individual projects included in this monorepo.
Tooling - For information about our tooling.
(Back to top) This section details our step-by-step setup process to rapidly start development according to our guidelines.
// TODO: Migrate to Wiki
// TODO: Node setup guide
// TODO: Lerna setup guide
// TODO: Visual Studio Code setup guide
// TODO: Highlight Visual Studio Code plugins that are essential, complete with project specific setup for each
// TODO: Document
(Back to top) // TODO: Migrate to Wiki
This section details our individual projects and their purpose.
// TODO: Document
// TODO: Redirect to separate client app readme
// TODO: Document
// TODO: Redirect to separate incident portal readme
// TODO: Document
// TODO: Redirect to separate customer portal readme
// TODO: Migrate to Wiki
This section details the primary tooling used to set up this monorepo, highlighting the essential features that we use from each.
| Tool | Function |
|---|---|
| Lerna | Lerna is a tool that optimizes the workflow around managing multi-package repositories with git and npm. It is the main glue that holds everything together. |
| TypeScript | Because who still writes plain JS, amirite? |
| Vue.js | Our frontend framework of choice. |
// TODO: Add more tooling and info
This project uses the GNU GPLv3 license. Please have a look at the LICENSE for more details.