Deriv API – Build and customise your trading app
Before running or contribute to this project, you need to have the setup of the following packages in your environment
- node >=14
- npm >=6.14
- git (for
contribution
)
Moreover, having these extensions will help you to speed up the development process and adhere to the best practices
- Prettier: setup in your editor https://prettier.io/ (or you can run
npm run format
)
-
Fork the project
In order to work on your own version of the Deriv application, please fork the project to your own repo.
-
Clone using SSH
git clone git@github.com:your-github-username/deriv-developers-portal.git
-
Enter project directory
cd deriv-developers-portal
-
Install your dependencies:
npm install
-
To start developing:
npm run dev
-
Release to staging:
Merging to master (squash and merge) will automatically release the last commit to the staging server https://staging-api.deriv.com/
- Release to production:
Releasing to production requires a tag using the following format:
production_VYYYYMMDD_${Integer}
--- Integer is the release version
PRs are based on the master branch
-
Create branch from the latest master branch
git checkout master git pull upstream master git checkout -b [_your_branch_name]
-
Make your changes
-
Make pull request
-
Push your changes to your origin
git push -u origin [_your_branch_name]
Upon creating PR, Vercel will auto-generate a test link inside the PR. you can use that to preview the test link for the changes you have made.