search

ronkok / Hurmet

Rich text editor on the web, featuring live calculations.
https://hurmet.org/
146 stars 1 forks source link

Installation instructions are missing #38

Closed johnblommers closed 4 days ago

johnblommers commented 1 week ago

It's not clear to me how to install and run this project. I already have Node.js installed and working on PopOS 22.04 (based on Ubuntu 22.04).

What does one do after cloning the repository to run Hurmet locally? Thanks in advance!

ronkok commented 1 week ago

cd to the Hurmet site directory and run node server.cjs. Then open a browser and navigate to http://localhost:8000/.

ronkok commented 1 week ago

Two other options for running Hurmet locally:

  1. cd to the Hurmet preview directory instead of site. Then node server.cjs will serve a non-minified version of the code. You'll lose access to other pages such as the documentation.

  2. If you are not connected to the Internet, another option is to just open your browser and navigate to hurmet.org. Hurmet is a progressive web app and it stores a version of itself on your local drive for offline use. The offline version has just the home page, not the documentation.

johnblommers commented 1 week ago

cd to the Hurmet site directory and run node server.cjs.

The problem is that there is no server.cjs file in the site directory. Perhaps I have missed a step. Here is what I've tried (with Node.js version v21.7.3 and yarn 3.2.2) :

git clone https://github.com/ronkok/Hurmet.git
cd Hurmet
yarn install
yarn run build
ronkok commented 1 week ago

Ah, I see now that I have server.cjs listed in my gitignore file. That's my bad. I'll fix it later today.

Just out of curiosity, is there any particular reason why a local run must involve Node? If I were to make the web app's offline version more robust and have the documentation available offline, would that be sufficient to meet your local needs?

johnblommers commented 1 week ago

Just out of curiosity, is there any particular reason why a local run must involve Node? If I were to make the web app's offline version more robust and have the documentation available offline, would that be sufficient to meet your local needs?

Yes, absolutely, it would be great not to involve Node at all, indeed that complicates matters. A progressive web app honors the "local-first" principle nicely.

ronkok commented 1 week ago

Thanks for the feedback. I'll go to work on that web app upgrade. Service workers are a little tricky and I have other things going on so this may take a few days.

johnblommers commented 1 week ago

Ah, I see now that I have server.cjs listed in my gitignore file. That's my bad. I'll fix it later today.

Excellent, that did the trick :-)

ronkok commented 4 days ago

I've upgraded the Hurmet PWA. The main documentation page is now available offline. I've also added Node.js instruction the README page.

Enjoy your offline work!