Pressunto is a content editor for GitHub that does not get in your way designed for managing markdown files in static websites. It aims the simplest editing experience you could hope for while preserving your original content structure.
You can read more in the Documentation
To run this project on your local device, there is two options.
- You can use the provided Dockerfile (recommended for production)
- You can run the project with npm installing the node_modules (recommended for development)
The project requires the following environment variables to be configured:
| Env var | Description |
|---|---|
| SESSION_SECRET | A random long string. Used internally for cookie session |
| GITHUB_CLIENT_ID | Client ID of your Github App. You can configure these in your Github profile settings |
| GITHUB_CLIENT_SECRET | Client Secret of your Github App |
| REDIS_URL | A working Redis URL. Used for caching and saving drafts |
A sample .env.example is provided with these keys blank. You can copy this file to a .env file if you intend to run locally with npm. When running locally, the dev server will read this file and load environment variables from the .env file.
To contribute to this project, create a fork under your name, write you changes to a branch with a name relating your changes and send a Pull Request. You can read a more detailed guide here.
Changes to the linter configuration and other architectural details and preferences (tabs, spaces, semicolons) won't be accepted without a strong argument but every PR will be read and discussed.
It's a wordplay between "Press" from "Wordpress" and "presunto", a word in spanish and portuguese. I'm from Spain and I like portuguese words and "presunto" means "ham" in portuguese and "alleged" in spanish, so I made a joke many times with that to my friends.