Neocities Local Development Setup

On Windows (host machine)

Install Ruby

winget install RubyInstallerTeam.Ruby.4.0

Add Ruby to your PATH (run in PowerShell)

$rubyPath = "C:\Ruby40-x64\bin"
$oldPath = [Environment]::GetEnvironmentVariable("Path", "User")
if ($oldPath -notlike "*$rubyPath*") {
    [Environment]::SetEnvironmentVariable("Path", $oldPath + ";$rubyPath", "User")
}

Then restart your terminal for the change to take effect.

Clone the repository

git clone https://github.com/bald-cap/neocities.git
cd neocities

Fix line endings on Vagrant scripts

dos2unix vagrant/common.sh vagrant/database.sh vagrant/development.sh vagrant/fs-primary.sh vagrant/redis.sh vagrant/ruby.sh vagrant/webapp.sh

Install Vagrant
```
winget install --id Hashicorp.Vagrant
```
Copy config file
```
cp config.yml.template config.yml
```
Start and provision the VM
```
vagrant up --provision
```
SSH into the VM
```
vagrant ssh
```

Inside the VM

Add the rackup gem
```
sudo bundle add rackup
```
Install gems
```
sudo bundle install
```
Start the server
```
bundle exec rackup -o 0.0.0.0
```

The site will be available at http://127.0.0.1:9292

1.3 KiB Raw Permalink Blame History

Neocities Local Development Setup

On Windows (host machine)

Inside the VM

1.3 KiB

Raw Permalink Blame History