Skip to content

Commit 9104171

Browse files
committed
Update README
1 parent 0a604a7 commit 9104171

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
## Future
1313

1414
- **Extended Data Format Support**: Adding compatibility for more marine EM data and general geophysical data formats.
15-
- **Expanded Visualizations**: e.g., Map, Navigation dashboard
15+
- **Expanded Visualizations**: e.g., Navigation dashboard
1616
- **Data Editing**: Integrating in-app data editing functionality for streamlined workflows. For now, it is **highly recommended to perform any data edits in the original data files** before uploading them into the app for visualization and analysis. This approach ensures the integrity of the data and allows the app to serve as a powerful decision-making tool based on visualized insights.
1717
- **Export results**: Export results for further analysis or publication.
1818

@@ -26,18 +26,19 @@ Follow these steps to set up **EMInsight** on your local machine:
2626
- [Node.js](https://nodejs.org/) (test on v22)
2727
- [Vite](https://vitejs.dev/) for project build and development
2828
- [React](https://reactjs.org/) and [TypeScript](https://www.typescriptlang.org/)
29+
- [bun](https://bun.sh/)
2930
- Backend
3031
- [Python](https://www.python.org/) (test on 3.12) for backend data pre-processing and scientific computation
3132

32-
For package manager, I'm using [bun](https://bun.sh/) but feel free to choose other commonly used package managers, e.g., npm, yarn, etc.
33+
For package manager, I'm using bun but feel free to choose other commonly used package managers, e.g., npm, yarn, etc.
3334

3435
### Steps
3536

3637
1. Clone the repository:
3738

3839
```bash
3940
git clone https://github.com/ycli0536/CSEMInsight.git
40-
cd EMInsight
41+
cd CSEMInsight
4142
```
4243

4344
2. Install the dependencies (frontend):
@@ -63,20 +64,22 @@ For package manager, I'm using [bun](https://bun.sh/) but feel free to choose ot
6364
pip install -r requirements.txt
6465
```
6566

66-
5. Run python script (backend):
67+
5. Run python script (backend) to deploy a development (Not Production!) server:
6768

6869
```bash
70+
cd backend
6971
python main.py
7072
```
7173

7274
6. Open the app in your browser at `http://localhost:5173`.
7375

74-
### Build for production
76+
### Build for production (Optional)
7577

76-
To create an optimized production build (not tried yet):
78+
To create an optimized production build (frontend) under `frontend/dist`:
7779

7880
```bash
79-
bun build
81+
cd frontend
82+
bun run build
8083
```
8184

8285
## Usage

0 commit comments

Comments
 (0)