CHAINED NOTES WEB

A web interface for chained notes.

BUILD PROCESS

Dependencies

• docker compose
• git
• mkcert

Getting started

1. Clone or download this repository.

   git clone https://github.com/msga-mmm/chained-notes-web.git
   cd chained-notes-web

2. Create local SSl certificate to be able to run the application in https locally for development and production parity https://12factor.net/dev-prod-parity.

   # change directory where the certificate and key will be created
   cd nginx/ssl
   
   # create SSL certificate and key for `localhost`
   mkcert -install -key-file dev.pem -cert-file cert.pem localhost

3. Start all the docker compose services:

   # start the services
   docker compose up
   
   # start the services in the background
   docker compose up --detach

4. After all the services have started, the frontend will be running at https://localhost. This may take a few minutes on the first run. You can verify the services are running correctly with docker compose ps. If you cannot access the frontend, check the service logs with docker compose logs frontend.

Testing

To run the end-to-end tests is necessary to install first playwright:

bunx playwright install

The above command will install playwright for all the browsers: firefox, chrome and webkit. To install playwright for a specific browser the following command can be used:

# chrome
bunx playwright install chrome

# firefox
bunx playwright install firefox

# webkit
bunx playwright install webkit

After the installation finishes the tests can be run with the following command:

# all browsers (headless mode)
bun run test:e2e

# all browsers (ui mode)
bun run test:e2e:ui

# specific browser (headless mode)
bun run test:e2e:chrome

# specific browser (ui mode)
bun run test:e2e:chrome:ui

Code design

Dependencies

• AJV: this package is defined as a dev dependency to fix the issue between bun and orval SyntaxError: Unexpected token ':'. More information at orval-labs/orval#1454

• eslint-plugin-react-hooks: this package is defined with the canary release 5.1.0 to solve the issue TypeError: context.getSource is not a function. More information at facebook/react#28773