Skip to content

docs fix spelling issues #1027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs fix spelling issues #1027

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,19 @@ $ yarn dev

## 📖 Documentation

The `injective-helix` is built using Nuxt and TailwindCSS and its powered by the [injective-ts monorepo](https://github.com/InjectiveLabs/injective-ts/).
The `injective-helix` is built using Nuxt and TailwindCSS and it's powered by the [injective-ts monorepo](https://github.com/InjectiveLabs/injective-ts/).

You can always boot the dex locally on your own laptop without having to set up a relayer. You can use the `public` network in your `VITE_NETWORK` `.env` configuration variable and run the `yarn run dev` command. You can find all of the available networks (i.e - predefined set of endpoints) [here](https://github.com/InjectiveLabs/injective-ts/blob/17b1aa5df39d5724baf6262b276980cf722a1cba/packages/networks/src/types.ts#L1). Using these endpoints (from the `public`) network gives the 40% of the trading fees to the community spend pool.

### Deployment

The `injective-helix` uses AWS for deployment. There is a CD pipeline set in the `.github/workflow/mainnet.yml` file. Deployment to AWS is done to a S3 bucket which is served through Cloudfront to the end user. Using `yarn generate` we are generating static html pages that are served through cloud front.

More details about how to deploy a Nuxt project can be found on their docs.
More details about how to deploy a Nuxt project can be found in their docs.

### Migration to Nuxt3

We've migrated the `injective-helix` repo to Nuxt3 in January, 2023. To make the migration on your fork, there are couple of simple steps that you have to do:
We've migrated the `injective-helix` repo to Nuxt3 in January, 2023. To make the migration on your fork, there are a couple of simple steps that you have to do:

1. Pull the latest codebase from the `injective-dex` repo, `master` branch,
2. Resolve merge conflicts on your fork,
Expand Down