Skip to content

A web-based application that gamifies medication adherence for children. Made for Atlanta nonprofit iCAN.

License

Notifications You must be signed in to change notification settings

GTBitsOfGood/ican

Repository files navigation

iCAN

Overview

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.

Tech Stack

  • TypeScript
  • Next.js
  • MongoDB
  • TailwindCSS

Repo Walkthrough

Find a full explanation of this repo here.

Onboarding

MongoDB

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.

Dependencies

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 install

This command should have installed all necessary dependencies for the app to run.

Development

To start the Next.js dev server, run both of these commands at the same time:

npm run dev
docker compose up

Code Formatting

Install 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.

About

A web-based application that gamifies medication adherence for children. Made for Atlanta nonprofit iCAN.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 18

Languages