A clean, Markdown-based publishing platform made for writers. Write together, and build a community. https://writefreely.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Matt Baer 3576ab15d1 Create issue templates пре 5 година
.github/ISSUE_TEMPLATE Create issue templates пре 5 година
author Add author package пре 5 година
cmd/writefreely Create basic server пре 5 година
config Fix overflowing green bg in setup titles пре 5 година
keys Move key generation to app from keys.sh пре 5 година
less Fully support single-user mode пре 5 година
page Add handler, page, template loading пре 5 година
pages Fully support single-user mode пре 5 година
parse Fix parse package import пре 5 година
static Fully support single-user mode пре 5 година
templates Use avatar as blog link social media image пре 5 година
.gitignore Clean up .gitignore пре 5 година
.travis.yml Add .travis.yml пре 5 година
CONTRIBUTING.md Explain where to post questions, feedback, bugs пре 5 година
LICENSE Use AGPL пре 5 година
Makefile Move key generation to app from keys.sh пре 5 година
README.md Fix badge пре 5 година
account.go Show number of followers on stats page пре 5 година
activitypub.go Add To and CC on Create activities пре 5 година
app.go Bump version to 0.2 пре 5 година
auth.go Fill in remaining missing pieces пре 5 година
cache.go Add login and post cache helpers пре 5 година
collections.go Use avatar as blog link social media image пре 5 година
database.go Insert missing default values on post creation пре 5 година
errors.go Fill in remaining missing pieces пре 5 година
export.go Add collection handlers, routes, feeds, sitemaps пре 5 година
feed.go Add collection handlers, routes, feeds, sitemaps пре 5 година
handle.go Remove r.Host from server logs пре 5 година
hostmeta.go Add ActivityPub components, routes, handlers пре 5 година
keys.go Move key generation to app from keys.sh пре 5 година
nodeinfo.go Fully support single-user mode пре 5 година
pad.go Fully support single-user mode пре 5 година
postrender.go Fully support single-user mode пре 5 година
posts.go Support retrieving posts as AS2 object пре 5 година
request.go Add collection handlers, routes, feeds, sitemaps пре 5 година
routes.go Fully support single-user mode пре 5 година
schema.sql Remove unneeded followers column from remoteusers пре 5 година
session.go Add collection handlers, routes, feeds, sitemaps пре 5 година
sitemap.go Add collection handlers, routes, feeds, sitemaps пре 5 година
templates.go Fix template loading on Windows пре 5 година
unregisteredusers.go Improve sign up пре 5 година
users.go Fill in remaining missing pieces пре 5 година
webfinger.go Add ActivityPub components, routes, handlers пре 5 година

README.md

 

Write Freely


Latest release Go Report Card Build status #writefreely on freenode

 

WriteFreely is a beautifully pared-down blogging platform that’s simple on the surface, yet powerful underneath.

It’s designed to be flexible and share your writing widely, so it’s built around plain text and can publish to the fediverse via ActivityPub. It’s easy to install and lightweight.

Start a blog on our instance

Try the editor

Find another instance

Features

  • Start a blog for yourself, or host a community of writers
  • Form larger federated networks, and interact over modern protocols like ActivityPub
  • Write on a dead-simple, distraction-free and super fast editor
  • Publish drafts and let others proofread them by sharing a private link
  • Build more advanced apps and extensions with the well-documented API

Quick start

Note this is currently alpha software. We’re quickly moving out of this v0.x stage, but while we’re in it, there are no guarantees that this is ready for production use.

First, download the latest release for your OS. It includes everything you need to start your blog.

Now extract the files from the archive, change into the directory, and do the following steps:

# 1) Log into MySQL and run:
# CREATE DATABASE writefreely;
#
# 2) Import the schema with:
mysql -u YOURUSERNAME -p writefreely < schema.sql

# 3) Configure your blog
./writefreely --config

# 4) Generate data encryption keys
./writefreely --gen-keys

# 5) Run
./writefreely

# 6) Check out your site at the URL you specified in the setup process
# 7) There is no Step 7, you're done!

For running in production, see our guide.

Development

Ready to hack on your site? Here’s a quick overview.

Prerequisites

Setting up

go get github.com/writeas/writefreely/cmd/writefreely

Create your database, import the schema, and configure your site as shown above. Then generate the remaining files you’ll need:

make install # Generates encryption keys; installs LESS compiler
make ui      # Generates CSS (run this whenever you update your styles)
make run     # Runs the application

License

Licensed under the AGPL.