cyberflamego / oasis-watch

A simple front-end to display OASIS HTLCs

OASIS.WATCH

A front-end to the OASIS API to display contracts in a user-friendly way.

Get started

Install the dependencies...

yarn
# or
npm install

...then start the auto-reloading development server:

yarn dev
# or
npm run dev

Navigate to localhost:5000 to see the app running.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

If you're using Visual Studio Code we recommend installing the official extension Svelte for VS Code. If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.

Building and running in production mode

To create an optimised version of the app:

npm run build

This will build the app into the docs folder, which can then be deployed.

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Single-page app mode

By default, sirv will only respond to requests that match files in docs. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.

If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for any path. You can make it so by editing the "start" command in package.json:

"start": "sirv docs --single"