|
1 | | -# ProjectM Visualizer Organization Website |
| 1 | +# ProjectM Visualizer — Official Website |
2 | 2 |
|
3 | | -This is the official website for the Projectm Visualizer organization, which hosts various visualizer projects and resources. |
| 3 | +[🔗 Visit the Website](https://projectm-visualizer.org) |
4 | 4 |
|
5 | | -## Development |
| 5 | +Welcome to the official website of the **ProjectM Visualizer** organization. This site serves as a central hub for our visualizer-related projects, resources, and community updates. |
6 | 6 |
|
7 | | -To set up the development environment, follow these steps: |
| 7 | +--- |
8 | 8 |
|
9 | | -1. Clone the repository: |
| 9 | +## 🛠 Development Setup |
| 10 | + |
| 11 | +Follow these steps to get the site running locally: |
| 12 | + |
| 13 | +### 1. Clone the Repository |
10 | 14 | ```bash |
11 | 15 | git clone https://github.com/projectM-visualizer/projectm-visualizer.org |
| 16 | +cd projectm-visualizer.org |
12 | 17 | ``` |
13 | 18 |
|
14 | | -2. Install bun.sh |
| 19 | +### 2. Install bun.sh |
| 20 | +#### Linux / macOS |
15 | 21 | ```bash |
16 | | -# Linux / macOS |
17 | 22 | curl -fsSL https://bun.sh/install | bash |
18 | 23 | ``` |
| 24 | +#### Windows |
19 | 25 | ```powershell |
20 | | -# Windows |
21 | 26 | powershell -c "irm bun.sh/install.ps1 | iex" |
22 | 27 | ``` |
23 | 28 |
|
24 | | -3. Install dependencies: |
| 29 | +### 3. Install dependencies: |
25 | 30 | ```bash |
26 | 31 | bun install |
27 | 32 | ``` |
28 | 33 |
|
29 | | -4. Start the development server: |
| 34 | +### 4. Start the development server: |
30 | 35 | ```bash |
31 | 36 | bun dev |
32 | 37 | ``` |
33 | 38 |
|
34 | | -5. Open your browser and navigate to `http://localhost:3000` to view the website. |
| 39 | +### 5. Open your browser and navigate to [http://localhost:3000](http://localhost:3000) to view the website. |
35 | 40 |
|
36 | 41 | <br> |
37 | 42 |
|
38 | | -## Screenshots |
| 43 | +## ⚠️ Known Issues |
39 | 44 |
|
40 | | -<div align="center"> |
41 | | - <!-- <img |
42 | | - src="./.github/assets/example.png" |
43 | | - alt="ProjectM Visualizer Website Screenshot" |
44 | | - width="100%" |
45 | | - /> --> |
46 | | -</div> |
| 45 | +- `bun install` may fail on Windows due to missing `node-gyp`. This is caused by `better-sqlite3`. |
| 46 | + - To fix this, you can run `npm install` followed by `bun install` to install the dependencies. |
| 47 | + - This will then allow you to utilize the environment without issues. |
| 48 | + - Linux has no issues with this. |
0 commit comments