Skip to content

Latest commit

 

History

History
86 lines (57 loc) · 3.31 KB

README.md

File metadata and controls

86 lines (57 loc) · 3.31 KB
Raw

🌟 Injective Helix

Helix | The Premier Decentralized Spot and Derivatives Exchange

Get a taste of the UI

✨ Features

  • Modern and intuitive design
  • Trade with ease and flexibility
  • Latest development and security practices
  • Awesome to use!

📚 Getting Started

  1. Clone the repository
$ git clone [email protected]:InjectiveLabs/injective-dex.git
$ cd injective-dex
$ yarn
  1. Duplicate the .env.example to .env and fill in the values
  2. Compile the app locally
$ yarn dev

📖 Documentation

The injective-helix is built using Nuxt and TailwindCSS and its powered by the injective-ts monorepo.

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. 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.

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:

  1. Pull the latest codebase from the injective-dex repo, master branch,
  2. Resolve merge conflicts on your fork,
  3. Install the dependencies yarn install
  4. Clean up left overs from the previous deployments yarn clean-up && rm -rf dist
  5. Update your .env file and add VITE_ prefix to all of the .env variables,
  6. Run the dex yarn dev

⛑ Support

Reach out to us at one of the following places!

🔓 License

Copyright © 2021 - 2024 Injective Foundation (https://injectivelabs.org/)

Originally released by Injective Foundation under:
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

 

Powering the future of decentralized finance.