search

webuild-community / federated-blog

A federated blog platform built for WeBuild Community
https://read.webuild.community/
58 stars 34 forks source link

readme

WeBlog
Federated Blog

A federated blogging platform built for WeBuild Community. Federated blog is a network of interconnected blogs or websites, which called the Fediverse.

It was built for the Webuild community but please feel free to use it for your own community.

Install

Please make sure you have node and yarn (or npm) installed on your machine.

To run federated blog locally or on your own server:

  1. Clone this repo
git clone https://github.com/webuild-community/federated-blog.git
  1. Within your terminal, run yarn to install the dependencies
  2. Once the dependencies are installed, run yarn dev to start the dev server on localhost:3000

Don't forget to check out the channels.json, where RSS feeds storage.

To run in production:

  1. Builds the production application into the .next folder:
yarn build
  1. Start Node.js server:
yarn start

To run test:

yarn test

Contributing

Please see our CONTRIBUTING.md.

We have a list of [good first issues] that contain bugs or features which have a relatively limited scope. This is a great place to get started and get familiar with our contribution process.

[good first issues]: https://github.com/webuild-community/federated-blog/labels/good%20first%20issue