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
- Get a Github and Cloudflare Workers account.
- Clone or download this repo. Then open terminal or command prompt inside the downloaded repo folder, where you see files such as
- You need to install Cloudflare Wrangler to communicate with Cloudflare server. First, make sure NodeJS is installed in your computer, then run
npm i @cloudflare/wrangler -gor
sudo npm i @cloudflare/wrangler -gif you're encountered permission error in Mac or Linux.
- In terminal/command prompt where
wrangler.tomlis located, run
sudo wrangler loginif you're encountered permission error in Mac or Linux.
- Open your browser, navigate to
https://workers.cloudflare.com, then login. In the dashboard, you'll see your Account ID on the right side of the page. Copy your Account ID and insert that into
- Still in Cloudflare Workers dashboard, navigate to KV section under Workers…
💻 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.
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 several steps in getting your ProgNovel ready.
ProgNovel works best when hosted on Jamstack platforms for performance and effiency purpose. Recommended platforms to host ProgNovel's frontend are Netlify, Vercel, and Cloudflare Page.
❗Before hosting the frontend, make sure you don't skip hosting your first…
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.