CONTRIBUTING.md

Contributing to ferdium-server

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

Table of contents

• Contributing to ferdium-server
  • Table of contents
  • Code of Conduct
  • What should I know before I get started?
  • How Can I Contribute?
  • Setting up your Development machine
    • Install System-level dependencies
      • Node.js, pnpm, python
      • Git
    • Clone repository with submodule
    • Install dependencies
    • Start development app
    • Styleguide
      • Git Commit Messages format
      • Javascript Coding style-checker

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].

What should I know before I get started?

For the moment, Ferdium's development is just getting started but all contributions (code, testing, bug-logging, feature-suggestions) are highly appreciated.

How Can I Contribute?

As a basic rule, before filing issues, feature requests or anything else, please take a look at the issues and check if this has not already been reported by another user. If so, engage in the already existing discussion.

Setting up your Development machine

Install System-level dependencies

Node.js, pnpm, python

Please make sure you are conforming to the engines requirements used by the developers/contributors as specified in the package.json and recipes/package.json files.

Currently, these are the combinations of system dependencies that work for MacOS/Linux/Windows:

$ jq --null-input '[inputs.engines] | add' < ./package.json < ./recipes/package.json
{
  "node": "20.18.0",
  "pnpm": "9.12.3",
  "python": "3.12.7"
}

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 repository with submodule

git clone https://github.com/ferdium/ferdium-server.git
cd ferdium-server
git submodule update --init --recursive --remote --rebase --force

It is important you execute the last command to get the required submodules (recipes).

Install dependencies

• Run the following command to install all dependencies, and link sibling modules with ferdium-server.

pnpm i

• Copy the .env.example file into .env and change the values to match your system.

cp .env.example .env

Note:

1. Have env DB_SSL=true only if your database is postgres and it is hosted online on platforms like GCP, AWS, etc
2. You will have to provide a value for API_KEY that is at least 16 characters long.

• If using sqlite for local development, create the database directory (whatever is set to DATA in .env)

mkdir -p data

• Run the database migrations with

node ace migration:refresh

• To get the full functionality, you will need to have an SMTP server running for local development.

Start development app

pnpm start --dev

Styleguide

Git Commit Messages format

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line
• When only changing documentation, include [ci skip] in the commit description

Javascript Coding style-checker

• Please use lint and lint:fix and the defined rules to maintain a consistent style