Development Setup

May 28, 2024 ยท View on GitHub

To contribute to this project, you'll need to set up your development environment. Please follow the instructions below to ensure you have the necessary tools and dependencies installed.

Prerequisites

Before you begin, make sure you have the following prerequisites installed on your system:

  • Node.js: This project requires Node.js, a JavaScript runtime, to build and run. You can download and install Node.js from the official website: Node.js Download.

    To check if Node.js is installed, open your terminal and run:

    node -v

    You should see the installed Node.js version.

Installation

After ensuring you have Node.js installed, follow these steps to set up your development environment:

  1. Clone the Repository: Fork and clone this repository to your local machine:

    git clone git@github.com:UmbrellaDocs/linkspector.git

  2. Change Directory: Navigate to the project directory:

    cd linkspector

  3. Install Dependencies: Use npm to install project dependencies:

    npm install

    This command will download and install all the required packages specified in the package.json file.

Contributing

You are now set up to contribute to the project! Follow the Contributing Guidelines for information on reporting issues, submitting pull requests, and more.