BirDt/nitinol-app-template
Template
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

submodule instructions

Browse source
This commit is contained in:
Jakub 2026-07-12 21:13:09 +08:00
parent 438ff03826
commit 5ca5e0546c
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.org
View file

@ -40,7 +40,8 @@ If you're new to Node.js development, start with ~npm i~ to install all dependen
You may also wish to install LIPS globally with ~npm -g install lips~, which will allow you to run a local repl with the ~lips~ command. You may also wish to install LIPS globally with ~npm -g install lips~, which will allow you to run a local repl with the ~lips~ command.
This is not required to use this framework, but is recommended. This is not required to use this framework, but is recommended.
You should also run ~npm run nitinol:update~ to pull in the Nitinol library files. The Nitinol libraries are included in this template as a git submodule under ~lib/nitinol~.
You can pull it in when cloning this template with ~git clone --recurse-submodules~, or ~git submodule update --init~ if you have already cloned the repository.
Then, the command ~npm run preview~ will start the backend and frontend. Then, the command ~npm run preview~ will start the backend and frontend.
@ -53,4 +54,3 @@ There are 3 main folders in this template that you should pay attention to.
- The Nitinol libraries are made automatically available to ~app.scm~ via a script tag in the HTML template. - The Nitinol libraries are made automatically available to ~app.scm~ via a script tag in the HTML template.
- ~server~ contains all backend server code, with the ~server.scm~ file being the entry point used to start the backend. - ~server~ contains all backend server code, with the ~server.scm~ file being the entry point used to start the backend.
- ~lib~ contains libraries potentially shared between the front and back end, as well as [[https://git.cyan.sh/BirDt/nitinol][Nitinol]] LIPS libraries included as a git submodule. - ~lib~ contains libraries potentially shared between the front and back end, as well as [[https://git.cyan.sh/BirDt/nitinol][Nitinol]] LIPS libraries included as a git submodule.
- ~npm run nitinol:update~ will update the Nitinol submodule.