If you'd like to be part of the development of sPhil, kindly follow the instructions below. If you have any further questions or would like to get involved, get in touch with Firgrep here.
0.0. Once you have access to the repo on github, fork and/or clone it into a folder where you keep your projects.
0.1. Then cd sphil
to get into the project directory.
0.2. Make your own development branch git branch dev-<your-name>
(example: git branch dev-tim
).
0.3. Set the newly made development branch as the current active branch, run git checkout <your-branch-name>
.
0.4. In future, when getting the latest changes from the main development branch, run git merge dev
whilst on your development branch to incorporate the changes into your branch.
1.0. Once inside, run npm i
(alias npm install
) to install all the packages. This will create the /node_modules
folder.
2.0. There are no environmental variables! This is a static website. (Caveat: we defined some public variables depending on where the site is hosted.)
9.9. Finally, to start a local development server, run npm run dev
and open up http://localhost:3000
on your favorite browser.
- Whenever you make any edits to the source files while the server is running, the server will pick up those changes and output them immediately. This is extremely handy during development, as you can input code and hit
ctrl
+k
thens
(save-all) and view directly your latest changes. - To terminate the server, hit
ctrl
+c
on your keyboard whilst in the terminal where the server runs, inputy
when prompted to terminate batch job.
โ You may get an error (e.g.
useRef
isnull
) as your development server refreshes. This is likely due to hownextra
processes themdx
files. Perform a hard refresh (hitF5
) to resolve this.