mirror of
https://github.com/immich-app/immich.git
synced 2024-12-28 06:31:58 +00:00
364b717fde
* cleanup install docs * Apply suggestions from mmomjian's code review Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com> * consequent wording simplifications * latest rewording of start/restart * Update requirements.md removed leftover newline --------- Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| blog | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tailwind.config.js | ||
| tsconfig.json | ||
Website
This website is built using Docusaurus, a modern static website generator.
Installation
$ npm install
Local Development
$ npm run 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
$ npm run 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 npm run deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> npm run 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.