Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 966 Bytes

CONTRIBUTION.md

File metadata and controls

30 lines (23 loc) · 966 Bytes

Contribution to this repo

Prerequisites

To contribute your code to this repo, you must have nodejs (at least v20 or higher) and python (at least version 12 or higher) for the best local working experience and package compatability.

You can also use docker to run it locally, but it's better to have latest versions of everything listed above to contribute your PR.

Open your PR

  1. Fork this repo and clone it to your local machine
  2. Make sure to work with the latest features from the "dev" branch
  3. Please, write clean, readable & relevant commits
  4. Make sure your changes pass all the pipline tests if you're contributing to the "server"

Running this project locally

  1. Clone this repo on your local machine:

    git clone https://github.com/alerrad/sociape.git

  2. Setup the project:

    bash install.bash

  3. Run the project:

    bash run.bash

Thanks for the contribution ✌️!