Build from Source

Development & Contributing
1

Prerequisites

In order to download necessary tools, clone the repository, and install dependencies via npm, you need network access.

  • Node.js: Ensure that Node.js is installed on your system. You can download it from the official website: https://nodejs.org/

  • npm: npm is typically installed alongside Node.js.

  • node-gyp: node-gyp is installed alongside the application but it requires additional tools and libraries depending on your operating system. Follow the instructions for your specific OS from: https://github.com/nodejs/node-gyp

  • Git: Suggested for cloning the repository. Download it from the official website: https://git-scm.com/

Installation Steps

  1. Clone the JSLAB repository:

    git clone https://github.com/PR-DC/JSLAB.git

  2. Navigate to the project directory:

    cd JSLAB

  3. Install the necessary dependencies:

    npm install

  4. Start the application:

    npm start

  5. Check examples from: https://github.com/PR-DC/JSLAB/tree/master/examples

Contributing

Setting Up the Development Environment

Follow the detailed build instructions available in this documentation.

Making Changes

Follow the coding style and best practices available in this documentation.

Submitting Changes

  1. Create a new branch for your feature or bugfix:

    git checkout -b feature/your-feature-name

  2. Make your changes and commit them with clear messages:

    git commit -m "Add feature X to improve Y"

  3. Push your branch to your forked repository:

    git push origin feature/your-feature-name

  4. Submit a Pull Request (PR) detailing your changes.

Testing

Before submitting a PR, ensure that all tests pass and add new tests for any new functionality you introduce.

Reviewing Process

All PRs are subject to review by the maintainers. Be prepared to make revisions based on feedback to align with project standards.

Best Practices

  • Consistent Formatting: Use a consistent code formatter (e.g., Prettier) to maintain uniform code style.

  • Meaningful Commit Messages: Write clear and descriptive commit messages that explain the purpose of the changes.

  • Modular Code: Write reusable and modular code to enhance maintainability and scalability.

  • Comprehensive Testing: Implement thorough tests to ensure the reliability of your contributions.