Skip to content
Online reference to the Endless Sky game
JavaScript Clojure HTML Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
frontend
resources
src/endless_ships
test-site
.gitignore
.gitmodules
.projectile
LICENSE.txt
README.md
boot.properties
build.boot

README.md

Endless Sky reference site generator

This is a tool for generating a website with reference information about the Endless Sky game.

The generator works by parsing the game's sources (specifically data/*.txt files) to get all game data so the information always stays up-to-date.

Installation

First you need to clone the project and pull the game which is linked as a git submodule:

$ git clone git@github.com:7even/endless-ships.git
$ cd endless-ships
$ git submodule update --init

The generator uses Boot so you need to install it (brew install boot-clj on OS X). It installs all the other Clojure dependencies upon first launch.

The client-side part of the site is being compiled using yarn so you need to install it as well (brew install yarn on OS X).

Generating the site

Just run the boot build command from the root directory of the application. It will put the generated files under the build/ directory, ready to be deployed to the server.

Viewing the site locally

If you don't want to deploy the site to the server you can view it locally - there's a bunch of ways to start a simple HTTP server for serving static files. For example here's how one would do that with Ruby:

$ cd build # the generated site will be available at build/
$ ruby -rwebrick -e'WEBrick::HTTPServer.new(:Port => 8000, :DocumentRoot => Dir.pwd).start'

Then point your browser to http://localhost:8000.

You can’t perform that action at this time.