aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a603706bff07e6a0d3116f9bfb198e55b97a6627 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# Dash Monorepo

## Project Structure

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
    ```