README.md

Speedway

🔱 🐬 🔱

A easy-to-use framework for building immersive decentralized applications.

Home | Discord | Issues | Docs

_{The quickest way to production in Web5. Built with ❤︎ by the Sonr Team and contributors}

Requirements

• have Taskfile installed
• have npm installed
• have the Go programming langague installed

Running Speedway UI

Install all the front end dependencies

npm install

Build the frontend

npm run build

Serve the backend

task server:start:release

Open your Browser to localhost:4040

Running Speedway CLI

Build the Speedway CLI

go build -o speedway cmd/speedway-cli/main.go

Run the help command

./speedway help

Known Issues

Speedway UI: Cannot use types other than string in objects or it casues issues with validation

Workaround: Use strings for all datatypes
Workaround: Use the cli
Workaround: Use the --file <file> flag on the CLI commands

The server sometimes fails due to `Concurrent Map Writes`

Workaround: Restart the server and repeat the action

Contributing

Building For Backend Dev

To build for dev, run `task server:start:debug` instead of `task server:start:release`

Running the Mock Backend

Running the UI: Mock Server Mode

This mode is ideal for UI development. Changes to the code will reflect on the browser automatically and there is no need to build. Any data generated will be local only. Behavior may not perfectly match the Sonr Speedway Backend.

Tun the Frontend:

npm install
npm start

on a second terminal, run the development server:

cd server-in-memory
npm install
npm start

The UI should open automatically on your browser, but if that's not the case, it can be found under localhost:3000

to reset the local data, go to:

localhost:3001/reset