From 04f4f494623748b8d7beff772a341a2a219ef577 Mon Sep 17 00:00:00 2001 From: Alfredo <193377562+A-Galicia@users.noreply.github.com> Date: Fri, 29 May 2026 10:29:48 -0700 Subject: [PATCH 1/4] fix: dev docs --- README.md | 30 +++++++++--------------------- 1 file changed, 9 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 4d83f77..f7f1bb1 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,6 @@ # GoatTimer -Web application that tracks a users study time - -## How to Run - -Create a backend `.env` file with: - -```sh -MONGO_URI=your_mongodb_connection_string -JWT_SECRET=your_long_random_secret -``` - -On the: npm install -Set `MONGO_URI` in `packages/backend/.env` to your MongoDB Atlas connection string -In one terminal start the backend: npm -w backend run dev -In another terminal: npm -w frontend run dev - -The backend defaults to port 5050, and the frontend dev server proxies `/api` -requests there. - -For JWT auth, set `JWT_SECRET` in `packages/backend/.env`. -Successful login/signup sets an HttpOnly cookie named `goattimer_jwt`. +For anyone who needs motivation to focus students, professionals, business owners **The Goat Study Timer** is a web app that keeps users accountable by tracking study time. It surfaces other competitors, lets users climb the ranks, and treats focus as a social experience. # Contributing - Formatting is default javascript and Prettier styles @@ -36,3 +16,11 @@ Successful login/signup sets an HttpOnly cookie named `goattimer_jwt`. - use the script "npm run dev" to start the service and check for linting errors - linting errors must be addressed or the service will not run - ensure no linting errors before pushing code + - ### Development Enviroment + - At root run "npm i" to install all packages + - in `packages/backend/.env` + - Set `MONGO_URI` to the MongoDB Atlas connection string + - For JWT auth, set `JWT_SECRET` + - In one terminal start the backend: npm -w backend run dev + - In another terminal: npm -w frontend run dev + - The backend defaults to port 5050, and the frontend dev server proxies `/api` requests there. \ No newline at end of file From e54840c044dd82db5b159f601d2e172559ec5712 Mon Sep 17 00:00:00 2001 From: Alfredo <193377562+A-Galicia@users.noreply.github.com> Date: Fri, 29 May 2026 10:33:23 -0700 Subject: [PATCH 2/4] feat: misc section --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f7f1bb1..9b35859 100644 --- a/README.md +++ b/README.md @@ -23,4 +23,11 @@ For anyone who needs motivation to focus students, professionals, business owner - For JWT auth, set `JWT_SECRET` - In one terminal start the backend: npm -w backend run dev - In another terminal: npm -w frontend run dev - - The backend defaults to port 5050, and the frontend dev server proxies `/api` requests there. \ No newline at end of file + - The backend defaults to port 5050, and the frontend dev server proxies `/api` requests there. + +# MISC +UI Prototype: https://www.figma.com/design/zncXfoG6arurPuARYN6voh/Goat-Timer?node-id=0-1&p=f&t=D3qkkV7s7rP8OXkM-0 + +Class Diagram: https://lucid.app/lucidchart/b21e47c0-d97b-4f2c-a8d7-765136d80f12/edit?page=0_0&invitationId=inv_159c0efd-5942-40aa-9582-62b534aa5c56# + +Demo Video: \ No newline at end of file From 8ec31af38b359aa9b1e91764ea9c98476f26001b Mon Sep 17 00:00:00 2001 From: Alfredo <193377562+A-Galicia@users.noreply.github.com> Date: Fri, 29 May 2026 10:44:31 -0700 Subject: [PATCH 3/4] fix: class url --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b35859..2d4c8bd 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,6 @@ For anyone who needs motivation to focus students, professionals, business owner # MISC UI Prototype: https://www.figma.com/design/zncXfoG6arurPuARYN6voh/Goat-Timer?node-id=0-1&p=f&t=D3qkkV7s7rP8OXkM-0 -Class Diagram: https://lucid.app/lucidchart/b21e47c0-d97b-4f2c-a8d7-765136d80f12/edit?page=0_0&invitationId=inv_159c0efd-5942-40aa-9582-62b534aa5c56# +Class Diagram: https://lucid.app/lucidchart/b21e47c0-d97b-4f2c-a8d7-765136d80f12/edit?viewport_loc=462%2C-16%2C2012%2C971%2C0_0&invitationId=inv_159c0efd-5942-40aa-9582-62b534aa5c56 Demo Video: \ No newline at end of file From 0c1b895330aa01cf47e46f061a29ed9b5b2fe483 Mon Sep 17 00:00:00 2001 From: Alfredo <193377562+A-Galicia@users.noreply.github.com> Date: Fri, 29 May 2026 11:01:30 -0700 Subject: [PATCH 4/4] feat: updated time --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2d4c8bd..a465afd 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,12 @@ For anyone who needs motivation to focus students, professionals, business owner - The backend defaults to port 5050, and the frontend dev server proxies `/api` requests there. # MISC -UI Prototype: https://www.figma.com/design/zncXfoG6arurPuARYN6voh/Goat-Timer?node-id=0-1&p=f&t=D3qkkV7s7rP8OXkM-0 +### UI Prototype +- https://www.figma.com/design/zncXfoG6arurPuARYN6voh/Goat-Timer?node-id=0-1&p=f&t=D3qkkV7s7rP8OXkM-0 +- last updated: 5/29/26 -Class Diagram: https://lucid.app/lucidchart/b21e47c0-d97b-4f2c-a8d7-765136d80f12/edit?viewport_loc=462%2C-16%2C2012%2C971%2C0_0&invitationId=inv_159c0efd-5942-40aa-9582-62b534aa5c56 +### Class Diagram +- https://lucid.app/lucidchart/b21e47c0-d97b-4f2c-a8d7-765136d80f12/edit?viewport_loc=462%2C-16%2C2012%2C971%2C0_0&invitationId=inv_159c0efd-5942-40aa-9582-62b534aa5c56 +- last updated: 5/29/26 Demo Video: \ No newline at end of file