https://github.com/lmcrean/dottie
Dottie : Your Period Bestie. Empowering adolescent girls with knowledge about their menstrual health through accessible, friendly AI-powered guidance.
https://github.com/lmcrean/dottie
concurrently express javascript node nodemon postgresql react sql sqlite tailwind three-js
Last synced: about 1 year ago
JSON representation
Dottie : Your Period Bestie. Empowering adolescent girls with knowledge about their menstrual health through accessible, friendly AI-powered guidance.
- Host: GitHub
- URL: https://github.com/lmcrean/dottie
- Owner: lmcrean
- License: other
- Created: 2025-03-11T17:30:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-12T06:47:19.000Z (about 1 year ago)
- Last Synced: 2025-05-12T07:41:20.457Z (about 1 year ago)
- Topics: concurrently, express, javascript, node, nodemon, postgresql, react, sql, sqlite, tailwind, three-js
- Language: TypeScript
- Homepage: http://dottie-lmcreans-projects.vercel.app
- Size: 8.11 MB
- Stars: 37
- Watchers: 3
- Forks: 46
- Open Issues: 30
-
Metadata Files:
- Readme: README-developers.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# README for Developers
This is a **Node.js monorepo** project with separate **frontend** and **backend** applications.
---
## 🔧 Prerequisites
You have two options for running the project in development mode:
---
## ⚙️ Option 1 (Recommended): Run Backend and Frontend in Separate Terminals
Start each service in its own terminal window.
### 1. Start Backend
```bash
cd backend
npm install
npm run dev
```
### 2. Start Frontend
```bash
cd frontend
npm install
npm run dev:frontend
```
---
## ⚡ Option 2: Run Backend and Frontend Concurrently in One Terminal
A concurrent workflow is available to run both services simultaneously using a single command.
```bash
cd frontend
npm install
npm run dev
```
---
## 🔍 Understanding the Dependency Chain (API Integration Guide)
When integrating new API features, ensure consistency across the **backend route**, **API request layer**, and **frontend UI test interface**.
### Example: `GET /user`
**Backend**
1. Route: `backend/routes/user/get-user/route.js`
2. Controller: `backend/routes/user/get-user/controller.js`
**Frontend**
3. API Request: `frontend/src/api/user/requests/getCurrentUser/Request.ts`
4. UI Test-Page: `frontend/src/test_page/test-endpoint-table/user/get-user-me/EndpointRow.tsx`
> ✅ All successful backend requests will be reflected in the `Developer Mode` UI, accessible via the bottom-right button.
---
## Node Version
This project uses Node.js v23.11.0
Run `nvm install` after cloning or switching branches to ensure compatibility.