Endless Ships

screenshot of Endless Ships
react

Endless Ships

Online reference to the Endless Sky game

Overview:

The Endless Sky reference site generator is a tool that allows users to generate a website containing reference information about the Endless Sky game. This generator parses the game's source files to retrieve all game data, ensuring that the information is always up-to-date.

Features:

  • Automatic Data Parsing: The generator automatically parses the game's source files to retrieve the latest game data.
  • Easy Installation with Docker: Users can quickly install, build, and run the generator with Docker.
  • Manual Installation Option: Alternatively, users can manually build the generator in their own environment.
  • Dependency Management: The generator uses Boot for managing Clojure dependencies and Yarn for compiling the client-side part of the site.
  • Site Generation: Users can generate the website by running the specified command from the root directory of the application.
  • Local Site Viewing: Users have the option to view the generated site locally without deploying it to a server.
  • Flexible Server Set up: Users can choose from various methods, such as using Ruby, to start a simple HTTP server for serving static files.

Installation:

Docker Installation:

  1. Clone the project.
  2. Build and run the project using the following command:
docker-compose up
  1. Connect to the project using http://localhost:8000.
  2. To take down the project afterwards, run the following command:
docker kill $(docker ps -q)

Manual Installation:

  1. Clone the project and pull the game submodule.
  2. Install Boot by running the command brew install boot-clj (OS X).
  3. Install Yarn by running the command brew install yarn (OS X).
  4. Generate the site by running the boot build command from the root directory of the application.
  5. The generated files will be stored in the build/ directory, ready to be deployed.

Local Site Viewing:

  1. Start a simple HTTP server for serving static files. For example, using Ruby, run the following command:
ruby -run -e httpd . -p 8000
  1. Open your browser and navigate to http://localhost:8000 to view the generated site.

Summary:

The Endless Sky reference site generator is a powerful tool for creating a website with up-to-date reference information about the Endless Sky game. With its automatic data parsing, easy installation options, and flexible server setup, users can quickly generate and view the website locally or deploy it to a server. Whether you are a fan of the game or a developer seeking to provide reference information, this generator is an invaluable resource.

react
React

React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components