Contributing

Prerequisites

This project is built with Astrojs and Starlight, which uses NodeJS. As a result to build this project locally you will need to have NodeJS, or a NodeJS compatible javascript runtime on your machine. On top of that you will need a package manager such as NPM, Yarn or PNPM.

This project uses Git as a version control system, and is hosted on Gitlab. So having a Gitlab account and Git installed on your system will help greatly in setting up the project locally and publishing your updates.

This project is built and deployed using Docker. While this is not needed for local development, if you wish to build the production version of this project, you will need Docker installed on your system.

Local Setup

Clone the repository

git clone git@gitlab.com:pcassima/dnd-wiki.git

Move into the directory
Terminal window
```
cd dnd-wiki
```
Install the dependencies
Terminal window
```
npm install
```

Running the development server

Once the dependencies have been installed, you can take the following steps to get the development server running:

Execute the following command in the root of the project
Terminal window
```
npm run dev
```
Open your favourite browser and navigate to http://localhost:4321

The development server will watch your files and will automatically refresh pages when you make changes.

If you want to build and run a pseudo-production build you can follow the following steps:

Run the following command in the root of the project
Terminal window
```
npm run build
```
Run the following command in the root of the project
Terminal window
```
npm run preview
```