retropilot-client/README.md

67 lines
979 B
Markdown

# retropilot-client
This is a lesser fork of upstream retropilot-client.
# Install
Debian Bullseye (11/stable).
```
sudo apt update
sudo apt install npm
git clone git@spacecruft.org:retropilot/retropilot-client.git
cd retropilot-client
npm install
```
# Configure
Configure thang.
```
# Just use .env.local not src/config.js?
#vim src/config.js
vim .env.local
# Perhaps something like:
REACT_APP_PUBLIC_URL=http://192.168.108.129:3000
REACT_APP_API_URL=http://192.168.108.128:8080
REACT_APP_WEBSITE_NAME="SpaceCruft RetroPilot Connect - Development"
```
Then open firewall on port `3000` if it is to be accessed remotely.
# Run
Run thang.
```
# Development
npm run start
# Testing
npm test
# Production
npm run build
```
# Use
Use thang.
Go here in a browser on the same machine running:
* http://192.168.108.129:3000/
# Fix
CORS.
# Upstream
This is forked from RetroPilot:
* https://github.com/retropilot/retropilot-client
See also `README-upstream.md`.