Skip to content

Commit 8625f4c

Browse files
authored
Update README.md
1 parent 59bdfa5 commit 8625f4c

1 file changed

Lines changed: 0 additions & 63 deletions

File tree

README.md

Lines changed: 0 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -95,69 +95,6 @@ data/
9595
└── timeline_events.json
9696
```
9797

98-
## 🛠️ Technologies Used
99-
100-
* **HTML5 / CSS3 / JavaScript**
101-
* **D3.js v7**
102-
* **Leaflet.js v1.9.4**
103-
* **Leaflet.heat**
104-
* **Turf.js**
105-
* **html2canvas**
106-
* **R / Python** for exploratory data analysis and preprocessing
107-
108-
109-
## 🧑‍💻 Running the Website Locally
110-
111-
Because the website loads local `.json` and `.geojson` files, it should be run through a local web server rather than opened directly with `file://`.
112-
113-
### Option 1: VS Code Live Server
114-
115-
1. Clone the repository.
116-
2. Open the project folder in VS Code.
117-
3. Install the **Live Server** extension.
118-
4. Open the website entry file, usually `index.html`.
119-
5. Right-click and select **Open with Live Server**.
120-
121-
### Option 2: Python Local Server
122-
123-
From the repository root, run:
124-
125-
```bash
126-
python -m http.server 5500
127-
```
128-
129-
Then open:
130-
131-
```text
132-
http://127.0.0.1:5500/
133-
```
134-
135-
If the website is located inside the `docs/` folder, open:
136-
137-
```text
138-
http://127.0.0.1:5500/docs/
139-
```
140-
141-
### Option 3: Node.js Local Server
142-
143-
If Node.js is installed, run:
144-
145-
```bash
146-
npx http-server -p 5500
147-
```
148-
149-
Then open the corresponding local URL in your browser.
150-
151-
## 🔄 Data Preprocessing
152-
153-
The repository includes preprocessing and exploratory analysis scripts used to transform raw datasets into website-ready files.
154-
155-
* `EDA.R` contains exploratory data analysis work.
156-
* `preprocess.py` contains preprocessing logic for generating structured data files.
157-
* Processed outputs are stored in the `data/` folder and loaded directly by the website.
158-
159-
If the data is updated, the processed files in the `data/` folder should be regenerated or replaced while preserving the filenames expected by the website.
160-
16198
## 📍 Milestones
16299

163100
### Milestone 1: Proposal

0 commit comments

Comments
 (0)