cswine
/
adept-web-app
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
5 Commits 1 Branch 0 Tags 977 KiB
JavaScript 67.6%
Python 18.6%
CSS 13.8%
Go to file Use this template
Jasen Qin c2d5f513dc autocommit 17-07-2024-13-04 2024-07-17 13:04:09 +10:00
.automate at a point that it works as a template 2024-07-17 12:49:23 +10:00
blog autocommit 17-07-2024-13-04 2024-07-17 13:04:09 +10:00
docs at a point that it works as a template 2024-07-17 12:49:23 +10:00
src Further polishing and removals 2024-07-17 13:02:07 +10:00
static Further polishing and removals 2024-07-17 13:02:07 +10:00
.gitignore at a point that it works as a template 2024-07-17 12:49:23 +10:00
LICENSE Initial commit 2024-07-17 01:59:12 +00:00
README.md add docusarus 2024-07-17 12:08:15 +10:00
babel.config.js add docusarus 2024-07-17 12:08:15 +10:00
docusaurus.config.js Further polishing and removals 2024-07-17 13:02:07 +10:00
package-lock.json add docusarus 2024-07-17 12:08:15 +10:00
package.json at a point that it works as a template 2024-07-17 12:49:23 +10:00
sidebars.js at a point that it works as a template 2024-07-17 12:49:23 +10:00
yarn.lock at a point that it works as a template 2024-07-17 12:49:23 +10:00

README.md

ADEPT

The adept web app.

Docusaurus.

This website is built using Docusaurus, a modern static website generator.

Installation

$ yarn

Local Development

$ 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.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.