Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Feb 13, 2017

README.md

Β· Backers on Open Collective Sponsors on Open Collective GitHub license

An open-source and a high performant publishing engine for pesonal blogs.

Deploy


Written in Typescript, React, Graphql, Express and Sequelize ORM.

Contents

Demo

To check letterpad in action, check out this Demo Site. You can visit the Admin Panel. It will auto log you in. However, the credentials are:

Email: demo@demo.com
Password: demo

Documentation

Documentation can be found at https://docs.letterpad.app.

Letterpad is an open source project, licensed under MIT.

Installation

Run the below commands to install:

git clone https://github.com/letterpad/letterpad.git
cd letterpad
yarn install

# Replace sample.env to .env

yarn dev

Optional:

Open the .env and change SECRET_KEY to a random string to secure your app. Then add your SMTP credentials for emails to work. Change the database options accordingly. By default, letterpad uses sqlite.

Now visit http://localhost:4040 and checkout the welcome page.

To visit the admin panel, visit http://localhost:4040/admin and login with

Email: demo@demo.com
PAssword: demo

Production Builds

The below command will create a build for the admin dashboard and the theme. It will build the default theme, Hugo

yarn build # creates a /dist folder
yarn prod  # run production

To build all the themes together, run

yarn buildAllThemes

Additional Links:

Contribute

Letterpad has reached a state of maturity but still has not released v1.0. You can contribute through various ways like testing, ideas, recommendations, fixing bugs, documentation, logo design, assets, etc. You can join the slack channel (letterpad.slack.com) for discussions. Thanks.

Contributors

Thanks to all the people who contributed. [Contribute].

Abhishek Saha
Abhishek Saha
Tien Pham
Tien Pham
Aleksey Derkach
Aleksey Derkach
Boopathi Rajaa
Boopathi Rajaa
Todd Cantley
Todd Cantley

Backers

Thank you to all our backers! πŸ™ [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Letterpad is released under the MIT License.

About

Letterpad is an open-source and a high performant publishing engine for blogs built with react & graphql and runs ridiculously fast πŸš€

Topics

Resources

License

Sponsor this project

Learn more about GitHub Sponsors
You can’t perform that action at this time.