Merge branch 'eleanor-gptdraw' of https://github.com/brown-dash/Dash-Web into eleanor-gptdraw

1 files changed, 70 insertions, 6 deletions

diff --git a/README.md b/README.md
index 0be27db8c..a603706bf 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,72 @@
-# Starter Project
-Install Node.js, then, from the project directory, run
+# Dash Monorepo
 
-* `npm install`
-* `npm start`
-* goto `http://localhost:1050`
+## Project Structure
 
-Note: `npm start` compiles and runs the application in debug mode, meaning that when you edit and save the source files, it will re-compile  and reload the browser window automatically.
+This monorepo contains:
+
+-   Dash web application (root directory)
+-   Dash Component library (`packages/components`)
+
+## Quick Start
+
+1. Install dependencies: `npm install`
+2. Start local development server: `npm start`
+    - Visit `http://localhost:1050/home`
+3. Start Storybook: `npm run storybook`
+    - Visit `http://localhost:6006/`
+
+## Development Setup Requirements
+
+### 1. Node.js Environment
+
+-   Install **`nvm`** (recommended) or install **`node`** and **`npm`** directly
+
+### 2. MongoDB Setup
+
+Download MongoDB:
+
+-   [Mac](https://fastdl.mongodb.org/osx/mongodb-macos-x86_64-4.2.3.tgz)
+-   [Windows x64](https://fastdl.mongodb.org/win32/mongodb-win32-x86_64-2012plus-4.2.3-signed.msi)
+-   [Other platforms](https://www.mongodb.com/download-center/community)
+
+#### MacOS Installation
+
+1. Copy MongoDB binaries:
+    ```bash
+    sudo cp /path/to/mongodb/bin/* /usr/local/bin/
+    ```
+2. Create required directories:
+    ```bash
+    mkdir -p ~/data/db
+    ```
+
+#### Windows Installation
+
+-   Run the installer
+-   Ensure "Add to Path" is selected during installation
+
+### 3. Project Setup
+
+1. Create required directories:
+    ```bash
+    mkdir -p src/server/public/files
+    ```
+2. Install dependencies:
+    ```bash
+    npm install
+    ```
+
+### 4. Running the Application
+
+1. Start MongoDB in a separate terminal:
+    ```bash
+    mongod
+    ```
+    If that fails, try:
+    ```bash
+    mongod --dbpath=/path/to/data/db
+    ```
+2. Start the application:
+    ```bash
+    npm start
+    ```