https://github.com/gammaswap/v1-interface

https://github.com/gammaswap/v1-interface

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/gammaswap/v1-interface
• Owner: gammaswap
• License: gpl-3.0
• Created: 2022-06-17T05:20:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-25T12:14:14.000Z (about 2 years ago)
• Last Synced: 2023-03-06T13:46:50.147Z (almost 2 years ago)
• Language: TypeScript
• Size: 2.45 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  



# Local Development

## Install Dependencies

1. Add .npmrc file in root folder with the following contents:

```

   @gammaswap:registry=https://npm.pkg.github.com/

   //npm.pkg.github.com/:_authToken=

```

2. Install the necessary packages by using the command after you have installed yarn:

`yarn`

## Run the project

`yarn dev`

If you receive an error about GitHub permission being denied, delete the file 'yarn-lock.json', then run the command again.

## Setup environment variables

Next.js comes with built in support for environment variables. This enables to do the following

- use `.env.local` to load environment variables

- Expose environment variables to the browser by prefixing with `NEXT_PUBLIC_`

> **NOTE:** If you did not use `NEXT_PUBLIC_` keyword as a prefix for your environment variable you will not be able to access the variable on frontend.

Create .env.local, .env.development and .env.production files. Add the environment variables in these files. For Example:

> NEXT_PUBLIC_ROPSTEN_API_KEY = MY_API_KEY

Now when the server runs Next.js will add the variable `NEXT_PUBLIC_ROPSTEN_API_KEY` in `process.env`. We can access this variable by using `process.env.NEXT_PUBLIC_ROPSTEN_API_KEY`.

`.env.local` file will always override the default set. So, if you want to run the `.env.development` or `.env.production` file then `.env.local` should be removed from the project otherwise development or production file will be overridden by local file.

Run `next dev` to load development environment variables and `next start` to load production environment variables

## Steps to deploy subgraph

This guide contains the required steps that are need to deploy the GammaSwap subgraph on local environment

[README.md](https://github.com/gammaswap/v1-subgraph/blob/subgraph-base/README.md)