Development

Prerequisites

To successfully run the Docpress application in development mode, you'll need to install the following prerequisites:

• Node.js: A JavaScript runtime that allows you to execute JavaScript code server-side. Make sure you install a version that is compatible with the project requirements.
• pnpm: A fast, disk space-efficient package manager for Node.js that is used to manage the project's dependencies.

Setting Up the Development Environment

Follow these steps to set up the development environment and start working with Docpress:

1. Clone the repository Start by cloning the Docpress repository to your local machine using Git:

   git clone https://github.com/this-is-tobi/docpress.git
   cd docpress

2. Install project dependencies Use pnpm to install all necessary Node.js dependencies:

   pnpm install

3. Fetch and build the website Run the following command to fetch documentation from the specified GitHub username and build the static website:

   pnpm run dev -U <github_username>

4. Preview the website Launch a local development server to preview your website:

   pnpm run vp:dev

   You can access the preview by navigating to http://localhost:8080 in your web browser.

TIP

Use command pnpm run dev -h to print options.

Contributions

All contributions to my repositories are welcome and must be made via Github with a pull request following the rules below.

Conventions

Commits must follow the specification of Conventional Commits, it is possible to add the VSCode extension to facilitate the creation of commits.

A PR must be made with an updated branch with the main branch in rebase (and without merge) before requesting a merge, and the merge must be requested in main.

Check whether the repository has linting rules or tests to keep them clean and ensure that CI workflows pass (new features in repositories with tests should be accompanied by new tests to ensure that the new feature works properly).