For developers and how to collaborate

How to get setup with the project

Getting started

Prerequisites

• Install Node.js
• Install npm
• Install git (If you are on Windows, you can use Git Bash instead of the default command prompt this is recommended)
• Alternatively 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 the dependencies using

      npm install

• Run the project using

      npm start

To change the website looks:

• Git clone the ruby-static repository using

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

• Change directory to the cloned repository

      cd ruby-static

• Install the dependencies using

      npm install

  • Switch back to the ruby directory which you cloned earlier

  • Install the static files using

      npm i (path to ruby-static directory)

  • Run the project using

      npm start

  Any changes you make to the ruby-static directory will be reflected in the website automatically as long as the project is running
• Open the browser and go to http://localhost:8080

When you are done making changes:

• In the ruby-static directory git add, commit and push your changes

• In the ruby directory first make sure to run

    npm i github:ruby-network/ruby-static

• Then to make sure you're changes are reflected in our CI

    rm -rf node_modules/

    rm package-lock.json

    npm i

After this you can commit and push your changes to the ruby repository

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 and or the ruby-static 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.