Skip to content

Commit 2b2d9be

Browse files
authored
Update README.md
1 parent a15a94c commit 2b2d9be

File tree

1 file changed

+69
-2
lines changed

1 file changed

+69
-2
lines changed

README.md

+69-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,71 @@
11
# [Three Body Problem](https://nbodyproblem-rvk9.onrender.com)
22

3-
I built a simulation of the N-Body problem with three js
4-
![image](https://github.com/user-attachments/assets/e3bc8ecd-e895-49f7-ba64-294891d4268c)
3+
This project offers an interactive simulation of the N-body problem using Three.js. Explore gravitational dynamics between multiple bodies in a three-dimensional space, with the ability to add new bodies, modify simulation settings, and observe real-time interactions.![image](https://github.com/user-attachments/assets/e3bc8ecd-e895-49f7-ba64-294891d4268c)
4+
5+
## Installation
6+
7+
1. **Clone the Repository**
8+
9+
```bash
10+
git clone https://github.com/NiniEdo/nbodyproblem.git
11+
```
12+
13+
2. **Install Dependencies**
14+
15+
Navigate to the project directory:
16+
17+
```bash
18+
cd nbodyproblem
19+
```
20+
21+
Install the required packages:
22+
23+
```bash
24+
npm install
25+
```
26+
27+
3. **Run the Simulation**
28+
29+
Start the development server:
30+
31+
```bash
32+
npm run dev
33+
```
34+
35+
Open your browser and navigate to `http://localhost:5173` to view the simulation.
36+
37+
4. **Build for Production**
38+
39+
To create a production build:
40+
41+
```bash
42+
npm run build
43+
```
44+
45+
The optimized files will be in the `target` directory.
46+
47+
5. **Run with Docker (Optional)**
48+
49+
Build the Docker image:
50+
51+
```bash
52+
docker build -t nbodyproblem .
53+
```
54+
55+
Run the Docker container:
56+
57+
```bash
58+
docker run -p 80:80 nbodyproblem
59+
```
60+
61+
Access the simulation at `http://localhost`.
62+
63+
## Requirements
64+
65+
- **Node.js** (version 16 or higher)
66+
- **npm** (comes with Node.js)
67+
68+
## Dependencies
69+
70+
- **Three.js**: For 3D rendering.
71+
- **Vite**: For development and build tooling.

0 commit comments

Comments
 (0)