Giter VIP home page Giter VIP logo

indiekit's Introduction

Indiekit

Build status

Meet Indiekit, the little Node.js server with all the pieces needed to share your content with the open, independent web.

Indiekit’s application management interface.

Sponsors

Indiekit is supported by its community. Special thanks to:

Jon RoobottomLocalazyKevin Yank

Features

  • Publish content to your website using apps and services that support the Micropub API
  • Save files to a content store such as GitHub, GitLab or an FTP server
  • Integrate with static site generators like Jekyll or Hugo
  • Share content on social networks like Twitter and Mastodon
  • Customise everything from the interface theme to the format of commit messages

Indiekit is extensible via its plugin API and localized for use in a growing number of languages.

Requirements

  • Node.js v18+

A MongoDB database is optional, but required for many features to work.

Get started

Learn how to set up an Indiekit server and view an example server configuration.

Documentation website

The documentation website is generated using VitePress. To view this site locally:

  1. Install this project’s dependencies: npm install
  2. Start Jekyll’s server: npm run docs:dev
  3. View the documentation: http://127.0.0.1:5173

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. These can be found in /docs/decisions.

Releasing

Lerna is used to manage and publish packages from this monorepo.

To release a new version, use the following command:

npx lerna publish --conventional-commits

Contributing

Read about the different ways you can contribute to this project.

Credits

Developed by Paul Robert Lloyd.

Thank-you to Aron Carroll for mentoring me during the development of this project. Indiekit is a much better project for his feedback and advice.

Similar projects

Indiekit is inspired by similar projects made by members of the IndieWeb community, all of which you are encouraged to try:

indiekit's People

Contributors

paulrobertlloyd avatar sentience avatar dependabot[bot] avatar alienlebarge avatar joebuhlig avatar lumenpink avatar lchski avatar xyb avatar afink70 avatar kwaa avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.