smart-van-2-0.github.io

This repository contains the Smart Van's Web Site source code used as GitHub Pages and at the smartvanbox.org url.

Repository that exports the smartvanbox.org Web Site as GitHub Pages.

• WebSite Version: 1.1.1
• Content Version: 20241029

CHANGELOG | TODOs | LICENCE

Current repo contains the source code of the Web Site published at smartvanbox.org. This WebSite is based on Docusaurus/Node.js and is structured into the following 3 sections, plus a Blog:

• Features: what the Smart Van can do for you
• Hardware: specs and guides to create your own SmartVan boxes
• Software: downloads and sources of all the software used by the SmartVan project

This repo, contrary other repos, use 4 principal brances:

• main: release branche used to merge develop and content branches
• develop: classic development branch used for Docusuarus configs and implementations
• content: branch dedicated to the contents updates
• gh-pages: dedicated branch to the GitHub Pages deployment

Run

To see the live version, please open a browser and navigate to https://www.smartvanbox.org.

Otherwise, to run it locally execute following commands. Remember that Node.js and Yarn must be installed on your machine in order to run this WebSite locally.

$ yarn install   # run it only once to install proj depedencies in 'node_modules' dir
$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. This command will also open the http://localhost:3000/ url in a local browser.

With the WebSite running locally using the start sub-command, you can edit content or docusaurus files and see the updates immediately at http://localhost:3000/.

Develop

This project allows 2 kind of updates:

• contents update: anything related with sections docs or blog articles
• and docusaurus updates: everything else like docusaurus configs but also commons react components

Update contents

When you must update some content you can use the content branch and create a sub-branch to commit your work. Once you have terminated with the task, then you can merge you sub-branch to the content branch.
Only when all content changes has been approved, the content branch can be merged into the main one. That triggers the GitHub Actions that builds and deploys the live smartvanbox.org WebSite.

• Features:
  add a Markdown page into the right folder and add his link to the main page
• Hardware:
  copy the _TMPL_hardware and populate with new model info
• Software:
  add a Markdown page into the right folder and add his link to the main page
• Blog:
  add a Markdown page into the blog folder and name it according to blog's conventions

Update Docusaurus & Co.

Before starting any new update, if not yet done, it's required to merge the main branch into the develop one.

Then when your develop branch is up-to-date, you can start implementing your updates. Like any other develop branch, you can create features/XY sub-braches to organize work and collaborate with others.
Finally when the updates have been approved, you need to syncronize also the contents. Somethimes a Docusaurus update requires to update also the content files. You can do it into the develop branch after merging the latest main branch. Update the content files and merge the develop branche into the main.

NB!: Since you merged latest main commit into the develop branch (in order to sync contents files), no content updates are allowed.