2020-01-30 18:39:56 +00:00
|
|
|
# Skynet Portal
|
2020-01-31 19:10:50 +00:00
|
|
|
|
2020-02-28 12:52:32 +00:00
|
|
|
## Web application
|
|
|
|
|
|
2020-10-20 12:46:34 +00:00
|
|
|
Use `yarn workspace webapp start` to start the development server.
|
2020-02-28 12:52:32 +00:00
|
|
|
|
2020-10-20 12:46:34 +00:00
|
|
|
Use `yarn workspace webapp build` to compile the application to `/public` directory.
|
2020-02-28 12:52:32 +00:00
|
|
|
|
2020-06-22 09:54:01 +00:00
|
|
|
You can use the below build parameters to customize your web application.
|
2020-02-28 12:52:32 +00:00
|
|
|
|
2020-10-20 12:46:34 +00:00
|
|
|
- development example `GATSBY_API_URL=https://siasky.dev yarn workspace webapp start`
|
|
|
|
|
- production example `GATSBY_API_URL=https://siasky.net yarn workspace webapp build`
|
2020-02-28 12:52:32 +00:00
|
|
|
|
2020-06-22 09:54:01 +00:00
|
|
|
List of available parameters:
|
|
|
|
|
|
|
|
|
|
- `GATSBY_API_URL`: override api url (defaults to location origin)
|
|
|
|
|
|
2020-08-27 20:34:48 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
2020-09-22 14:46:24 +00:00
|
|
|
### Testing Your Code
|
2020-09-14 13:57:44 +00:00
|
|
|
|
2020-08-27 20:34:48 +00:00
|
|
|
Before pushing your code you should verify that it will pass our online test
|
2020-09-14 13:57:44 +00:00
|
|
|
suite.
|
2020-08-27 20:34:48 +00:00
|
|
|
|
2020-09-14 13:57:44 +00:00
|
|
|
**Cypress Tests**
|
2020-08-27 20:34:48 +00:00
|
|
|
Verify the Cypress test suite by doing the following:
|
2020-09-14 13:57:44 +00:00
|
|
|
|
2020-08-27 20:34:48 +00:00
|
|
|
1. In one terminal screen run `GATSBY_API_URL=https://siasky.net yarn workspace webapp start`
|
|
|
|
|
1. In a second terminal screen run `yarn workspace webapp cypress run`
|
|
|
|
|
|
2020-06-22 09:54:01 +00:00
|
|
|
## Setting up complete skynet server
|
2020-02-28 12:52:32 +00:00
|
|
|
|
2020-06-22 09:54:01 +00:00
|
|
|
A setup guide with installation scripts can be found in [setup-scripts/README.md](./setup-scripts/README.md).
|
