Skip to content

Commit 5e1fd71

Browse files
author
pakat
committed
refactor README.md
1 parent 56e765c commit 5e1fd71

File tree

1 file changed

+41
-29
lines changed

1 file changed

+41
-29
lines changed

README.md

Lines changed: 41 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,63 +7,75 @@ This is the website for JCONF Peru (Java Conference Peru) - the premier Java con
77
- **Production**: [https://jconfperu.com](https://jconfperu.com)
88
- **Preview/Sandbox**: [https://jconfperu-etqvmqfyo-dario-lunas-projects.vercel.app](https://jconfperu-etqvmqfyo-dario-lunas-projects.vercel.app)
99

10-
## Local Development
10+
## 🚀 Local Development
1111

12-
This website is built with Jekyll and can be served locally for development.
12+
This website is a static landing page built with HTML, CSS, and JavaScript, powered locally by [Vite](https://vitejs.dev/).
1313

14-
### Prerequisites
14+
### 🧱 Prerequisites
1515

16-
- Ruby 2.7.0 or higher
17-
- Bundler gem
18-
- For Windows, you can use RubyInstaller: https://rubyinstaller.org/
16+
- Node.js **v22.20.0** or higher (recommended)
17+
- [fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm) for managing Node versions (optional but helpful)
1918

20-
### Setup
19+
### ⚙️ Setup
2120

2221
1. **Install dependencies:**
2322
```bash
24-
bundle install
23+
npm install
2524
```
2625

2726
2. **Start the development server:**
2827
```bash
29-
bundle exec jekyll serve
28+
npm run dev
3029
```
3130

32-
3. **Open your browser and navigate to:**
31+
3. **Open your browser at:**
3332
```
34-
http://localhost:4000
33+
http://localhost:5173
3534
```
3635

37-
### Development with Live Reload
36+
### 🔁 Development with Live Reload
3837

39-
For automatic browser refresh when files change:
38+
Vite provides instant hot module replacement (HMR). Any changes to HTML, CSS, or JS will automatically refresh the browser.
4039

41-
```bash
42-
bundle exec jekyll serve --livereload
43-
```
44-
45-
This will start:
46-
- Main site: http://localhost:4000
47-
- LiveReload server: http://localhost:35729
48-
49-
### Additional Commands
40+
### 🛠️ Additional Commands
5041

51-
- **Build the site (without serving):**
42+
- **Build the site for production:**
5243
```bash
53-
bundle exec jekyll build
44+
npm run build
5445
```
5546

56-
- **Serve with custom port:**
47+
- **Preview the production build locally:**
5748
```bash
58-
bundle exec jekyll serve --port 3000
49+
npm run preview
50+
```
51+
52+
- **Serve on a custom port:**
53+
Edit the `vite.config.js` file:
54+
```js
55+
export default {
56+
server: {
57+
port: 3000
58+
}
59+
}
5960
```
6061

6162
- **Stop the server:**
62-
Press `Ctrl+C` in the terminal where Jekyll is running
63+
Press `Ctrl+C` in the terminal where Vite is running.
64+
65+
### 🧩 Troubleshooting
6366

64-
### Troubleshooting
67+
If you see an error like:
6568

66-
If you encounter permission errors during `bundle install`, the project is configured to install gems locally in the `vendor/bundle` directory to avoid system permission issues.
69+
```
70+
You are using Node.js 20.11.1. Vite requires Node.js version 20.19+ or 22.12+. Please upgrade your Node.js version.
71+
```
72+
73+
Update Node.js using `fnm`:
74+
75+
```bash
76+
fnm install 22.20.0
77+
fnm use 22.20.0
78+
```
6779

6880
## 🚀 Deployment & Preview System
6981

0 commit comments

Comments
 (0)