Mood Tracker WebApp

Web application to track mood based on React and NestJS.

Pipeline status:

Prerequisites

Package Manager

This repo is based on Yarn2. Ensure that you have a global installation of Yarn2. Note: nodeLinker is set to node-modules as migrating to pnp is out of scope for now. To use yarn2, you need node version >= 10.19.

You can test if yarn is installed correctly by using:

yarn --version

Install docker to run postgres.

Quick starter on running the app

Installing all the dependencies

yarn

Note: Ensure docker is up and running.

docker ps

Create .env file based on .env.example in packages/backend/rest-mood-tracker.

Create .env file based on .env.example in packages/frontend/ui-mood-tracker

Start the backend

yarn start:backend

Start the frontend

yarn start:frontend

The database is already seeded with a mock user for ease of testing:

username: testuser
password: moodtracker666$!

Please find the documentation specific to the apps inside the app ReadMe linked in the following section:

Workspace Structure

This application follows a monorepo approach. The following sections explains the folder structure:

• ./.github/: PR templates and Github Action definitions.
• ./.yarn/: Dependencies installed from yarn2.
• ./packages/: TypeScript applications defined as independent modules.
  • frontend/: Folder containing the frontend application.
  • backend/: Folder containing the backend application.
• ./
  • [screenshots]: Folder containing screenshots of the app for desktop, tablet and mobile.
  • .eslintrc.js: ESLint rules.
  • .gitignore: File and folder globs to be ignored by git.
  • .yarnrc.yml: Config file for yarn2.
  • package.json: The node package definition, with packages links and and scripts.
  • yarn.lock: Auto generated lock file from yarn.