kbsbroad / wrighter

Wrighter - A Powerful Markdown Blogger & A Writing Companion | write the (w)right way

Wrighter - A Powerful Markdown Blogger & A Writing Companion ⚡

• Wrighter has a powerful WYSIWYM markdown editor and a renderer (batteries included ⚡)
• It is optional signup, so you can use wrighter offline too! or you can fork this project and use wrighter standalone
• Wrighter has a feature called bites, that allow you to gather & organize bite sized ideas and later use them in your blogs
• ...and a lot more features that aims to make modern writing easier and productive!

To read more about it, visit here or here

Setup

• To run wrighter locally, you just need to clone the app
• ensure to install prisma and tsnd globally
• run yarn on root directory, it will install all the deps for both client and server
• create .env.local file in wrighter-client with

API_BASE_URL="<INSERT BACKEND URL HERE>"

Example of configuration file:

API_BASE_URL="http://localhost:8080/api"

• create .env file in wrighter-server with

DATABASE_URL="<INSERT DB URL HERE>"
SECRET_KEY="<SOME SECRET>"
COOKIE_SECRET="<COOKIE SECRET>"

Example of configuration file:

DATABASE_URL="mysql://wrighter_user:secrete_wrighter_pass@127.0.0.1:3306/wrighter_db"
SECRET_KEY="SECRETkeyforwrighterapplication"
COOKIE_SECRET="SECRETCookieforwrighterapplication"

• from the root directory, run yarn dev, it would concurrently run both the server and client
• goto localhost:3000 to see wrighter ✨

Contributing

• Contributions and feature ideas are welcome 🤗