self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-28 09:33:27 +02:00
Code Issues Releases Activity
298370b7be
immich/docs
History
aviv926 e3d39837d0
docs: Add Google OAuth example (#9778) 
* Add Google OAuth example

* npm run format:fix

* fix

* PR feedback

* Fix
2024-05-27 03:39:59 -04:00
..
blog feat: dream comes true 2024-05-02 01:33:17 +01:00
docs docs: Add Google OAuth example (#9778) 2024-05-27 03:39:59 -04:00
src docs: community docs typos (#9604) 2024-05-19 15:50:46 -04:00
static chore(server): email notification button png (#9423) 2024-05-13 15:36:35 +00:00
.gitignore Small docs site tweaks (#954) 2022-11-10 08:20:23 -06:00
.nvmrc fix(deps): update typescript-projects (#9454) 2024-05-13 21:42:48 -04:00
.prettierignore ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
.prettierrc ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
babel.config.js Change documentation folder to docs 2022-10-27 21:44:37 -05:00
docusaurus.config.js docs: add discord link (#9379) 2024-05-10 12:38:35 -05:00
package-lock.json fix(deps): update typescript-projects (#9454) 2024-05-13 21:42:48 -04:00
package.json fix(deps): update typescript-projects (#9454) 2024-05-13 21:42:48 -04:00
README.md docs: use npm in README (#9566) 2024-05-17 16:49:23 -04:00
sidebars.js ci: doc format check (#2325) 2023-04-24 12:49:20 -05:00
tailwind.config.js chore: Remove sponsor link from homepage (#9226) 2024-05-02 11:42:54 -05:00
tsconfig.json fix(deps): update docs (#7068) 2024-02-13 14:07:16 +00:00

README.md

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.