Skip to content

Letterpad is an open-source and a high performant publishing engine, built with react & graphql and runs ridiculously fast 🚀

Notifications You must be signed in to change notification settings

WooodHead/letterpad

 
 

Repository files navigation

Letterpad Admin is the dashboard for publishing blogs.

Features

  • High performant API.
  • Uses Graphql, React Apollo and NextJS
  • Uses Letterpad Editor (on top of DraftJS), specially built for this CMS.
  • Theme customisation (css) from Dashboard
  • CDN Powered images (Uses cloudinary and Unsplash)
  • Connects to multiple databases. Default is sqlite3
  • Can be used as a multi-user service
  • Light and Dark Theme
  • Minimalistic Dashboard

Demo:

https://letterpad.app/admin/login

User Id: demo@demo.com Password: demo

Running Letterpad Admin on Production Mode

There are few things that you should know before running letterpad in a production environment.

  • In the root folder, you will find a file env.development.local. Clone is file and rename it to env.production.local. The most important key is SECRET_KEY, set the value of this key to something different. This key is used to encrypt passwords, sessions and preview links.

  • Letterpad Admin runs on the url /admin. If you would like to run the admin dashboard in the root url, edit next.config.js and remove the basePath. Also open env.production.local and remove the /admin from all the urls.

  • Run the below commands.

yarn install
yarn seed
yarn build
yarn start # starts the server
Email - demo@demo.com
Password - demo

Enabling Emails

Letterpad integrates with Sendgrid. You can add the SENDGRID_API_KEY in .env.production.local file to activate emails.


Captcha for registrations

This section is required only if you want to use Letterpad as a multi-user account. Letterpad uses ReCaptcha. You can register and set the RECAPTCHA_KEY in env.production.local.


Running Letterpad on Development Mode

First install the node modules and seed the database using

yarn install
yarn seed

Then, run the development server:

yarn dev

Open http://localhost:3000/admin with your browser. You can login with the test account mentioned below

Email - demo@demo.com
Password - demo

Letterpad has been developed using Next.js. To learn more about Next.js, take a look at the following resources:

Letterpad Client

We also have a letterpad client which you can find in this repository. The letterpad client is a simple react application which uses the graphql API of letterpad to render a public facing blog. Demo: https://demo.letterpad.app

Contribute

You are welcome to contribute to the project. If you find any bugs, please create an issue or a pull request. Also if you would like to have a feature, feel free to inform us with an issue.

About

Letterpad is an open-source and a high performant publishing engine, built with react & graphql and runs ridiculously fast 🚀

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 85.6%
  • TypeScript 12.9%
  • Other 1.5%