mirror of
https://github.com/immich-app/immich.git
synced 2025-02-05 18:36:34 +02:00
3e12b10866
* fix: use example.com domain for from_address_description * fix: remove unnecessary screenshot from docs
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.