The goal of this repository is to verify that your development environment is set up to start working on code at dYdX. Successfully running the tests in this repo confirms that your environment is close to or completely set up to work with dYdX repositories.
We also provide examples of common Typescript types you will encounter at dYdX in src/types. These objects are then used and tested in __tests__/basicFlowTests.
Clone the repository with one of the following
git clone [email protected]:dydxprotocol/systemCheck.git
git clone https://github.com/dydxprotocol/systemCheck.git
Create a new branch locally
git checkout -b <branch_name>
Stage files to be committed
git add <file_names>
Add a commit with a message
git commit -m "<message>"
Push to the remote branch
git push origin <branch_name>
Create the pull request on github.com from your branch to master
Here is a list of helpful git commands.
Pick a text editor you are comfortable with. Most editors should have javascript support. Many engineers at dYdX use VSCode or Atom.
Many dYdX services are written in NodeJs with Typescript. When installing node a version of npm will come with it. To get the latest version of npm run:
npm install -g npm@latest
To install all packages needed for the repo, run:
npm i
Set your node version to 12. NVM is a good tool for managing your node version. When installing nvm you will need to use an install script. To change to node version 12 run:
nvm use 12
- Run all commands from the root directory of the repository.
- In one terminal run
npm run compile:watch. This will allow for continual building as you make changes to files. - In a second terminal run your tests with
npm run test. You can add a test filename as an optional argument if you don’t want to run the whole test suite. This command pattern matches for all files with .test.ts so you don’t need to include the entire path, for examplenpm test -- __tests__/basicFlowTests.