Skip to content

dev_setup.md

Latest commit

 

History

History
49 lines (31 loc) · 1.3 KB

dev_setup.md

File metadata and controls

49 lines (31 loc) · 1.3 KB
Raw

Development Setup Guide

This guide provides instructions for setting up the development environment for the OSRS quest data npm module.

Prerequisites

Before proceeding, ensure you have the following prerequisites installed on your system:

  • Node.js (version 16.x or higher)
  • npm (Node.js package manager)
  • Git (version control system)

Getting Started

  1. Clone the repository:

    git clone https://github.com/jamescer/osrs-tools.git

  2. Navigate to the project directory:

    cd osrs-tools

  3. Install dependencies:

    npm install

Building the Module

To build the npm module and generate distribution files, run the following command:

npm run build

Releasing

This project uses changesets to track changes and generate CHANGELOG.md. When you make a user-facing change:

npm run changeset

This prompts for the affected bump type (patch/minor/major) and a summary, and writes a changeset file to .changeset/ — commit it alongside your change. When it's time to cut a release, npm run changeset:version consumes the pending changesets, bumps the version in package.json, and updates CHANGELOG.md.