Skip to content

Commit 395c85b

Browse files
authored
Update README.md
1 parent df594a7 commit 395c85b

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

Source code/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,19 @@ This folder contains the full source code for the OpenHardware Initiative websit
1010
- `...`
1111
- `public/` — Static assets (images, uploads, etc.)
1212

13-
## 🛠️ Development
14-
- Built with [React](https://react.dev/), [Vite](https://vitejs.dev/), [TypeScript](https://www.typescriptlang.org/), [Tailwind CSS](https://tailwindcss.com/), and [Bun](https://bun.sh/)
15-
- All data is managed in `src/data/` as TypeScript files
16-
- No database or CMS required
17-
1813
## 📦 Data Management
19-
See [`../DATA_MANAGEMENT_README.md`](../DATA_MANAGEMENT_README.md) for how to add or edit people, events, or projects.
14+
- See [`DATA_MANAGEMENT_README.md`](DATA_MANAGEMENT_README.md) for how to add or edit people, events, or projects.
15+
- See [`APPLICATION_CONFIG_README.md`](APPLICATION_CONFIG_README.md) for how to set-up & remove an application form.
2016

2117
## 🏗️ Building & Deploying
22-
See [`../DEPLOYMENT_README.md`](../DEPLOYMENT_README.md) for how to build and deploy the site with Bun and GitHub Pages.
18+
See [`DEPLOYMENT_README.md`](DEPLOYMENT_README.md) for how to build and deploy the site with Bun and GitHub Pages.
2319

2420
## ⚡ Quick Start
2521
1. Install dependencies (if needed):
2622
```sh
2723
bun install
2824
```
29-
2. Start the dev server:
25+
2. Start the dev server (test the website locally):
3026
```sh
3127
bun run dev
3228
```
@@ -35,6 +31,11 @@ See [`../DEPLOYMENT_README.md`](../DEPLOYMENT_README.md) for how to build and de
3531
bun run build
3632
```
3733

34+
## 🛠️ Development
35+
- Built with [React](https://react.dev/), [Vite](https://vitejs.dev/), [TypeScript](https://www.typescriptlang.org/), [Tailwind CSS](https://tailwindcss.com/), and [Bun](https://bun.sh/)
36+
- All data is managed in `src/data/` as TypeScript files
37+
- No database or CMS required
38+
3839
## 📝 Notes
3940
- SPA routing is supported for GitHub Pages, Vercel, and Netlify
4041
- All application links are managed via `src/config/applicationConfig.ts`

0 commit comments

Comments
 (0)