README.md

MemoFinder

Wiki

Milestones

Installing all dependencies

you must have at least Python Version 3.9

run the following command in the root directory of the repository:

yarn install:all

you can also run yarn install in each of the individual directories

Linting the project

run the following command in the root directory of the repository:

yarn lint

you can also run yarn lint in each of the individual directories

Running the backend

in the ./backend directory run the command:

yarn start

Running the frontend

in the ./frontend directory run the command;

yarn start

NOTE: If you run into issues with eslint asking you to delete CR then simply run yarn lint in the ./frontend directory and try starting the frontend once again

Testing the backend

in the ./backend directory run the command:

yarn test

to run all tests

Integration Testing

For integration testing, we use Cypress. Before running the tests, make sure the backend is running.

cd ./backend
yarn start
cd ../frontend
yarn cy:run # runs tests in headless mode (terminal)
yarn cy:open # runs tests in interactive mode (GUI)

See a run of the tests here. You may need to download the video to view it.