After a nearly six months with Grant for the Web my project ProgNovel is finally live! 🚀
Previously private Github repos are now public, with a CLI is being published to NPM.
🤖 ProgNovel Workers
How to get ProgNovel backend
- Make sure you have a Github account and Cloudflare Workers account first, and make sure you have publish content to Cloudflare Workers network by following https://github.com/prognoveljs/prognovel-cli. Start by clicking Cloudflare Workers deploy button above.
- Authorize Clouflare Workers with your Github account. If you are redirected to the main page of Cloudflare Workers deploy site after authorizing, simply click browser's go back button to return to ProgNovel backend's deploy page.
- Add your account information. Enter your Cloudflare Workers Account ID and API Token, which the deploy page has guide for.
- The deploy process will pause once you get to the next step and will ask you to enable Workflow for Github Action of your repo. Click the link to your repo and enable Github Action for your repo if you haven't already. Go back to the deploy page and click the "Workflow…
💻 ProgNovel CLI
👇 ProgNovel CLI installation
Before you install ProgNovel CLI, you need to host backend for ProgNovel first. Follow installation guide for ProgNovel Workers backend here. Once your backend live, proceed installing the CLI:
- Install ProgNovel CLI to your computer. You need a stable release of Node.js installed first, then in command prompt, run
npm install @prognovel/cli -g.
- In an empty folder, open command prompt and run
- You need to have a way to connect to Cloudflare Workers servers by setting the value of environment secrets. If you manage your ProgNovel project folder locally in a computer, you can configure environment secrets via
.envfile in your root project folder created in step (2) - (
.envfile might be hidden in your Explorer app); if you host this project folder on Github repo, you can consult this page to create your environment…
ProgNovel is a JAMstack web app to make great webnovels. The main feature of ProgNovel, beside offline-first web app with offline read features and great performance, is to be able to inject interactive plugins for content creators to experiment with. Because ProgNovel built mainly in Jamstack architecture, it can be hosted with great loading page performance on many Jamstack platform free-tier offerings such as Netlify and Cloudflare Workers.
Although ProgNovel strives to be as simple as possible, it is currently very difficult to create a smooth flow for deployment due to how young Jamstack ecosystem is (the architecture ProgNovel uses). In the future as the toolings more mature, we're hoping to simplify the deployment process - but for now we'll have to get our hands dirty and go through…
Though technically anyone can self-host ProgNovel now, I'm still actively looking for installation bugs and doing trials and errors to test the deployment flow to ensure the installation instructions are correct (unfortunately here I didn't manage to make them as simple as I want to be due to CI/CD issues with hosting/backend platforms). Not to mention that the documentation is still needs a little bit polishing. So while the code are being public I still need a bit time to actively announce that ProgNovel is published.
I'm expecting for an official launch around 10~15 December. For now, feel free to look around and let me know if there's anything that interest you.