Skip to content

Contributing

Thanks for considering contributing to this project. There are a number of way you can help this project grow and improve:

For this project to be a safe, welcoming space for collaboration, contributors must adhere to our code of conduct.

Tell a friend

One of the best (and easiest) ways to grow this project is to tell people about it!

If you are using Indiekit, add yourself to the list of people using Indiekit on the IndieWeb wiki.

Propose a feature

The motivation behind Indiekit is to build a tool that makes interacting with IndieWeb protocols and technologies accessible, adaptable and approachable. Indiekit also aims to be platform agnostic and built for the long term.

Features and improvements that move the project closer to these goals are strongly encouraged.

We use GitHub issues to track feature requests. Browse existing proposals before adding yours.

Report a bug

We use GitHub issues to track bugs. Browse existing reports before adding yours.

Submit a fix

If you spot something broken and can supply a fix, fork the project and create a pull request. See setting up a local development environment to get started.

Commit messages for fixes should be prefixed with fix:, for example:

fix: do not throw error for signed in users

If a fix affects a specific module, include the name of the module in the commit message, for example:

fix(endpoint-micropub): only return queried values

Improve the documentation

Documentation should be accessible, easy to read and avoid jargon.

Documentation can be found in the /docs folder and uses Markdown syntax. You can use GitHub’s interface to contribute changes.

Commit messages for documentation updates should be prefixed with docs:, for example:

docs: fix typo in getting started instructions

Add a localisation

Localazy is used to manage localisations. If you see a translation that is not quite right or would like to add a new language, create an account and contribute to the project.

Develop a plug-in

You can use Indiekit’s plug-in API to add (or prototype) a new feature.

When publishing a plug-in to the npm registry, add the indiekit-plugin keyword to help other Indiekit users find it. To have a plug-in listed in the plug-in directory, submit a pull request against the relevant page in the documentation.

Setting up a local development environment

Project structure

This project uses a monorepo structure, with concerns split into separate Node modules located in the /packages folder:

ModulePurpose
indiekitCoordinating functions and the Express web server.
frontendFrontend component library, used for the application interface.
errorError handling for the core module and plug-ins.
create-indiekitProject initialiser, used when running npm create indiekit.
endpoint-*Application endpoint plug-ins.
preset-*Publication preset plug-ins.
store-*Content store plug-ins.
syndicator-*Syndicator plug-ins.

Helper functions used in tests are in the /helpers folder.

Project architecture

Indiekit uses the Express server framework.

Configuration defaults get merged with any user-defined values (Indiekit uses cosmiconfig to find and load a configuration object).

Plug-ins listed under the plugins array are then loaded and interrogated for known API methods, which further update the configuration.

Express waits for a resolved configuration file before starting the server.

Running locally

To run the server locally, first install its dependencies:

sh
npm install

The provided configuration file allows some options to be assigned using environment variables.

Create an .env file in the root of the project, for example:

sh
# Required
PUBLICATION_URL="https://example.com"

# Database connection string URI (optional)
MONGO_URL="mongodb://127.0.0.1:27017"

# Test saving files to a content store on GitHub (optional)
GITHUB_USER="username"
GITHUB_REPO="indiekit-test"
GITHUB_BRANCH="main"
GITHUB_TOKEN="12345abcde"

# Test syndicating content to a Mastodon server (optional)
MASTODON_URL="https://example.social"
MASTODON_USER="indiekit-test"
MASTODON_ACCESS_TOKEN="12345abcde"

You can then start the server:

sh
npm start

To automatically restart the server whenever a file change is detected, use:

sh
npm run dev

To enable authentication, use the production flag:

sh
npm run dev --production

Tests

The project uses both unit and integration tests. Run tests using the following command:

sh
npm test

To run an individual test, use node followed by the path to the test. For example:

sh
node packages/indiekit/test/index.js

Test coverage

The project aims to achieve close to 100% test coverage. You can check code coverage by running the following command:

sh
npm run test:coverage

Linting

Consistent and high-quality code is maintained using Prettier with ESLint used to check JavaScript files and Stylelint used to check CSS stylesheets.

You can check that any changes use the preferred code style by running the following command:

sh
npm run lint

You automatically fix any issues by running the following command:

sh
npm run lint:fix