How to Collaborate

How to get setup with the project

Getting started

Prerequisites

• Install Node.js
• Install npm
• Install yarn
• Install git (If you are on Windows, you can use Git Bash instead of the default command prompt)
• Alternativley you can install node and npm using nvm
  • Windows: nvm-windows
  • Linux And Mac: nvm

Setup

For developers

• Clone the repository using

      git clone https://github.com/ruby-network/ruby

• Change directory to the cloned repository

      cd ruby

• Install yarn using

      npm install -g yarn

• Install the dependencies using

      yarn install

• Run the project using

      yarn prod

• To modify the frontend only, run

      yarn dev

• To modify the backend and frontend, run

      yarn prod

  • this builds the frontend and starts the server
• To build the frontend only, run

      yarn build

• To start the server only without building the frontend, run

      yarn start

For contributors

• Fork the repository
• Make a new branch for your changes
• Make your changes
• Commit and push your changes to your fork
• Make a pull request to the ruby repository
• Remember to follow contribution guidelines and code of conduct

The developers section has some information for contributors as well, but it is not necessary to follow it if you are not a developer.