skynet-webportal/packages/dashboard-v2/README.md

# Skynet Account Dashboard

Code behind [account.skynetpro.net](https://account.skynetpro.net/)

## Development

This is a Gatsby application. To run it locally, all you need is:

- `yarn install`
- `yarn start`

## Accessing remote APIs

To have a fully functioning local environment, you'll need to make the browser believe you're actually on the same domain as a working API (i.e. a remote dev or production server) -- otherwise the browser will block the session cookie.
To do the trick, configure proper environment variables in the `.env.development` file.
This file allows to easily control which domain name you want to use locally and which API you'd like to access.

Example:

```env
GATSBY_PORTAL_DOMAIN=skynetfree.net # Use skynetfree.net APIs
GATSBY_HOST=local.skynetfree.net # Address of your local build
```

> It's recommended to keep the 2LD the same, so any cookies dispatched by the API work without issues.

With the file configured, run `yarn develop:secure` -- it will run `gatsby develop` with `--https -p=443` options.
If you're on macOS, you may need to `sudo` the command to successfully bind to port `443` (https).

Gatsby will automatically add a proper entry to your `/etc/hosts` file and clean it up when process exits.
ops: initial Dashboard v2 directory setup 2022-02-15 09:04:19 +00:00			`# Skynet Account Dashboard`

			`Code behind [account.skynetpro.net](https://account.skynetpro.net/)`

			`## Development`
ops(dashboard-v2): setup (& satisfy) prettier 2022-02-17 11:16:21 +00:00
ops: initial Dashboard v2 directory setup 2022-02-15 09:04:19 +00:00			`This is a Gatsby application. To run it locally, all you need is:`

ops(dashboard-v2): setup (& satisfy) prettier 2022-02-17 11:16:21 +00:00			- `yarn install`
			- `yarn start`
docs(dashboard-v2): add notes on how to run HTTPs locally 2022-03-23 10:30:19 +00:00
			`## Accessing remote APIs`

ops(dashboard-v2): improve local developer experience 2022-04-12 10:55:09 +00:00			`To have a fully functioning local environment, you'll need to make the browser believe you're actually on the same domain as a working API (i.e. a remote dev or production server) -- otherwise the browser will block the session cookie.`
			To do the trick, configure proper environment variables in the `.env.development` file.
			`This file allows to easily control which domain name you want to use locally and which API you'd like to access.`
docs(dashboard-v2): add notes on how to run HTTPs locally 2022-03-23 10:30:19 +00:00
ops(dashboard-v2): improve local developer experience 2022-04-12 10:55:09 +00:00			`Example:`
docs(dashboard-v2): add notes on how to run HTTPs locally 2022-03-23 10:30:19 +00:00
ops(dashboard-v2): improve local developer experience 2022-04-12 10:55:09 +00:00			```env
			`GATSBY_PORTAL_DOMAIN=skynetfree.net # Use skynetfree.net APIs`
			`GATSBY_HOST=local.skynetfree.net # Address of your local build`
docs(dashboard-v2): add notes on how to run HTTPs locally 2022-03-23 10:30:19 +00:00			```

ops(dashboard-v2): improve local developer experience 2022-04-12 10:55:09 +00:00			`> It's recommended to keep the 2LD the same, so any cookies dispatched by the API work without issues.`

			With the file configured, run `yarn develop:secure` -- it will run `gatsby develop` with `--https -p=443` options.
			If you're on macOS, you may need to `sudo` the command to successfully bind to port `443` (https).
docs(dashboard-v2): add notes on how to run HTTPs locally 2022-03-23 10:30:19 +00:00
ops(dashboard-v2): improve local developer experience 2022-04-12 10:55:09 +00:00			Gatsby will automatically add a proper entry to your `/etc/hosts` file and clean it up when process exits.