CONTRIBUTING.md

Contributing to the Ferdium Website

🎉 First off, thanks for taking the time and your effort to make Ferdium better! 🎉

Table of contents

• Table of contents
• Code of Conduct
• How do I contribute?
  • Setup your development environment
    • Node.js, pnpm
    • Git
  • Clone the repository
  • Install dependencies
  • Add your modifications
  • Build the website locally
• Learn More

Code of Conduct

This project and everyone participating in it is governed by the Ferdium Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How do I contribute?

Setup your development environment

Node.js, pnpm

You will need a working installation of Node.js, with the pnpm package manager. It is advised to use the version recommended in the ferdium-app repository.

Note: You can choose any version manager to manage multiple versions of node and npm. For eg, nvm or asdf.

Git

The version 2.23.0 for Git is working fine for development. You can then use the console from Git to do the development procedure.

Clone the repository

git clone https://github.com/ferdium/ferdium-website.git

Install dependencies

Run the following command to install all dependencies for NextJS.

pnpm install

Add your modifications

First, run the development server:

pnpm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the content by modifying .tsx files in pages/ or components/. The page auto-updates as you edit the files.

Build the website locally

Ferdium website is statically generated to be served by GitHub Pages. To locally build and export the next website, run the following command. The static output will be generated in out/.

pnpm run export

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!