Skip to main content

Installation

This is a personal project that I made to keep track of how much time I spend doing chores at home.

Live Demo: Click here

Screenshots

Main section in dark mode

Main section screenshot

Charts in light mode

Chart section screenshot

Getting started

  • Clone the repository
git clone https://github.com/jose-506/ChoreTracker.git
  • Install dependencies
cd ChoreTracker/
npm install
cd src/client/
npm install
  • Set a DATABASE_URL (MongoDB Atlas connection string) on .env.
MONGODB_URI=mongodb://<user>:<password>@<connection_url>
  • Start the back-end and front-end
cd ChoreTracker/
npm run dev

Web Stack – MERN

  • MongoDB as the document database
  • Express as the web framework
  • React as the client‑side library
  • Node as the web server

Project Structure

NameDescription
src/Contains the back‑end and front‑end source code
src/client/Contains the front‑end files
src/client/srcContains the front‑end source code
src/config/Contains the MongoDB connection and authentication URL
src/models/Contains the MongoDB schema
src/routes/Contains the HTTP methods for CRUD operations
src/server.tsEntry point to the Express app
dist/Contains the output from the TypeScript build
node_modules/Contains all the npm dependencies
package.jsonFile that contains the npm dependencies as well as build scripts
tsconfig.jsonConfig settings for compiling server code written in TypeScript