Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/getindiekit/indiekit

The little Node.js server with all the parts needed to publish content to your personal website and share it on social networks.
https://github.com/getindiekit/indiekit

indieauth indieweb micropub

Last synced: 7 days ago
JSON representation

The little Node.js server with all the parts needed to publish content to your personal website and share it on social networks.

Host: GitHub
URL: https://github.com/getindiekit/indiekit
Owner: getindiekit
License: mit
Created: 2019-02-13T22:00:14.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2024-10-08T20:24:51.000Z (3 months ago)
Last Synced: 2024-10-29T17:34:31.690Z (2 months ago)
Topics: indieauth, indieweb, micropub
Language: JavaScript
Homepage: https://getindiekit.com
Size: 20.2 MB
Stars: 340
Watchers: 6
Forks: 36
Open Issues: 45
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- License: LICENSE

Awesome Lists containing this project

README

        # Indiekit



[![Build status](https://github.com/getindiekit/indiekit/workflows/build/badge.svg)](https://github.com/getindiekit/indiekit/actions)

Meet [Indiekit](https://getindiekit.com), the little Node.js server with all the pieces needed to share your content with the open, independent web.

![Indiekit’s application management interface.](/docs/public/interface-light.png)

## Sponsors

Indiekit is [supported by its community](https://github.com/sponsors/getindiekit). Special thanks to:



## Features

- **Publish content to your website** using [apps and services](docs/clients.md) that support the [Micropub API](https://micropub.spec.indieweb.org)

- **Save files to a content store** such as GitHub, an FTP server or S3 object storage

- **Integrate with static site generators** like Eleventy, Hugo or Jekyll

- **Share content** on social networks like Mastodon

- **Customise everything** from the interface theme to the format of commit messages

Indiekit is extensible via its [plug-in API](docs/api/index.md) and localized for use in [a growing number of languages](docs/configuration/localisation.md).

## Requirements

- Your own website, published using a static site generator

- [Node.js](https://nodejs.org) v20+

A [MongoDB](https://www.mongodb.com) database is optional, but required for the following features to work:

- Viewing, editing, deleting and restoring previously published posts

- Syndicating posts

- Viewing and deleting previously uploaded media files

> [!NOTE]

> This project is known to work with MongoDB v4.4 or later. It may also work with the last openly licenced version, v4.0.3, but this has not been tested.

## Get started

Learn how to [set up an Indiekit server](docs/get-started.md) and view an [example server configuration](https://github.com/getindiekit/example-config).

## Documentation website

The documentation website is generated using [VitePress](https://vitepress.vuejs.org). To view this site locally:

1. Install this project’s dependencies: `npm install`

2. Start the Vite server: `npm run docs:dev`

3. View the documentation: 

The browser will refresh to reflect any changes you make to the documentation.

## Decisions

Architectural decisions made on this project are documented using Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). These can be found in [`/docs/decisions`](docs/decisions).

## Releasing

[Lerna](https://lerna.js.org) is used to manage and publish packages from this monorepo.

To release a new version, use the following command:

```sh

npx lerna publish --conventional-commits

```

## Contributing

Read about the different ways [you can contribute to this project](docs/contributing.md).

## Credits

Developed by [Paul Robert Lloyd](https://paulrobertlloyd.com).

Thank-you to [Aron Carroll](https://aroncarroll.com) for mentoring me during the early development of this project. Indiekit is a better project for his feedback and advice.

## Similar projects

Indiekit is inspired by similar projects made by members of the [IndieWeb community](https://indieweb.org):

- [Mastr Cntrl](https://github.com/vipickering/mastr-cntrl) by [Vincent Pickering](https://vincentp.me)

- [Micropub endpoint](https://github.com/muan/micropub-endpoint) by [Mu-An Chiou](https://muan.co)

- [Micropub to GitHub](https://github.com/voxpelli/webpage-micropub-to-github) by [Pelle Wessman](https://kodfabrik.se)

- [Postr](https://github.com/grantcodes/postr) by [Grant Richmond](https://grant.codes)

- [SiteWriter](https://github.com/gerwitz/sitewriter) by [Hans Gerwitz](https://hans.gerwitz.com)