Overview
Tech Stack
This project was generated using Nx (opens in a new tab) and is programmed primarily in TypeScript.
Frontend
Web Framework - Angular
UI Components - Ionic + Material (to deprecate one?)
Style System - Ionic (migrate to tailwind?)
Native Apps - Capacitor
Testing - Jest(unit) Cypress(E2E)
Backend
Database - Postgres
ORM - Sequelize
Rest APIs - NestJS
Testing - Jest(unit)
Containerisation - Docker
Prerequisites
-
Download and install Git (opens in a new tab). This will be used to download the repository
-
Download and install Node (opens in a new tab) version 16+. This is the programming language required to run the project
-
Download and Install Yarn (opens in a new tab). This manages all 3rd-party code dependencies
Project Setup
- Clone the project repo (opens in a new tab)
- Setup your editor extensions to include the Nx Console extension for faster development
Running the Project
- Install dependencies
yarn install
- Build the project
yarn build
- Start the app
yarn start