This project is a web-based application that gamifies medication adherence for children in clinical trials, with the goal of increasing adherence by creating a direct, engaging incentive for children. The envisioned app involves caring for a virtual pet whose health reflects the child's adherence to their medication regimen. This model for gamification is inspired by modern Tamagotchi applications in which reaching certain goals allows a user to care for a pet, plant, or other charismatic entity that reflects the user’s status in reaching personal goals.
Find a full explanation of this repo here.
Install MongoDB Community Server to host a local instance of MongoDB. It may also be helpful to download MongoDB Compass to view the state of your database.
Make sure you have Node.js 18 installed. Check by running node -v. If your Node version is less than 18, either reinstall Node from the prior link or manage multiple versions of Node with a tool like nvm.
In the root directory of the project, run:
npm installThis command should have installed all necessary dependencies for the app to run.
In the root directory, run one of these commands based on your OS:
npm run secrets:linux # mac / linux
npm run secrets:windows # windowsYou should be prompted for a master password. Ask your Engineering leadership to continue. Once the password has been verified, your .env.development.local file should have been created automatically for you.
If you are unable to use the commands to retrieve the .env file, you can download or visit Bitwarden and login using product@bitsofgood.org and the master password. The .env file will be available within the vault.
To start the Next.js dev server, run:
npm run devInstall and enable Prettier in VSCode. This repository is also configured with a pre-commit hook that automatically formats any code you commit to ensure formatting consistency throughout the codebase.
- Install Docker
- Obtain the Bitwarden password from your EM. Create a
bitwarden.envfile and fill it in with the following contents:This only needs to be done on your first run. After that, you should delete the file from your repository to avoid pushing it to Github.BW_PASSWORD=<your bitwarden password> - Start the application with Docker Compose:
docker compose up
If you make any changes to the packages, you may need to rebuild the images. To do this, append --build to the above docker compose up command.
The Dockerized application will have live-reloading of changes made on the host machine.
Note: On linux-based operating systems, if you come across an entrypoint permission error (i.e. process: exec: "./entrypoint.sh": permission denied: unknown), run chmod +x ./entrypoint.sh to make the shell file an executable.
Windows Users: If you come across this error exec ./entrypoint.sh: no such file or directory when running the docker compose command, please follow this Stackoverflow thread to fix it.