https://github.com/wolfadex/space-traders-ui

A UI for https://spacetraders.io/
https://github.com/wolfadex/space-traders-ui

elm-lang game-development

Last synced: 2 months ago
JSON representation

A UI for https://spacetraders.io/

• Host: GitHub
• URL: https://github.com/wolfadex/space-traders-ui
• Owner: wolfadex
• Created: 2023-05-10T19:06:33.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-29T12:50:35.000Z (over 1 year ago)
• Last Synced: 2024-10-20T00:48:49.069Z (3 months ago)
• Topics: elm-lang, game-development
• Language: Elm
• Homepage: https://space-traders-elm-wip.netlify.app/
• Size: 3.62 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SpaceTraders UI

A UI for [SpaceTraders](https://spacetraders.io/), built with [Elm](https://elm-lang.org/)

## ⚠️ WIP ⚠️

[![Netlify Status](https://api.netlify.com/api/v1/badges/d156e8fd-a09c-4628-b345-1b574e2471c4/deploy-status)](https://app.netlify.com/sites/space-trader-elm-wip/deploys)

## Current Features

- auth

- view your Agent

- view your Contracts

- view (parts of) your ships

  - move ships between being docked and being in orbit

  - move to waypoints within the same system

  - extract resources

  - sell cargo

- view systems, in 3D!

- view waypoints










---




# Development

## Prerequisites

If you haven't yet, read the SpaceTraders API docs https://docs.spacetraders.io/. There's also the useful refernce https://spacetraders.stoplight.io/docs/spacetraders for viewing the OpenAPI spec as docs.

I use [Nix](https://nixos.org/) for my development and highly recommend it. If you also use Nix, then setup will be very quick.

If you don't use Nix, you'll need to install

- [Node.js](https://nodejs.org)

- [Elm](https://guide.elm-lang.org/install/elm.html)

## Setup

_I use [direnv](https://direnv.net/). If you do as well, you'll want to run `direnv allow` in the root of this repo._

Then, regardless of whether you use direnv or not, you'll need to run:

```sh

npm install

```

Once that's complete, run `npm run dev` to start the dev server.

This uses [run-pty](https://www.npmjs.com/package/run-pty) to start up multiple CLI tools and lets you interact with them individually.

- a dev server

- elm compiler, using [elm-watch](https://lydell.github.io/elm-watch/)

- elm code gen

- [elm-review](https://package.elm-lang.org/packages/jfmengels/elm-review/latest/) for code review