External/domain-watchdog
1
0
Fork 0
mirror of https://github.com/maelgangloff/domain-watchdog.git synced 2025-12-29 16:15:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update documentation

Browse Source
This commit is contained in:
Maël Gangloff
2025-11-14 17:29:14 +01:00
parent 4f35d9f8b5
commit 16a6ea46c1
1 changed files with 28 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/src/content/docs/en/self-hosting/manual-install.mdx
View File

@@ -2,7 +2,7 @@
title: Manual Install title: Manual Install
--- ---
import {LinkCard, Steps} from '@astrojs/starlight/components'; import {FileTree, LinkCard, Steps} from '@astrojs/starlight/components';
## Installation ## Installation
@@ -30,11 +30,11 @@ git clone https://github.com/maelgangloff/domain-watchdog.git
#### Backend #### Backend
<Steps> <Steps>
1. Install dependencies: 1. Install dependencies
```shell ```shell
composer install composer install
``` ```
2. Set up your environment variables: 2. Set up your environment variables
```shell ```shell
cp .env .env.local cp .env .env.local
``` ```
@@ -44,15 +44,15 @@ git clone https://github.com/maelgangloff/domain-watchdog.git
```shell ```shell
php bin/console lexik:jwt:generate-keypair php bin/console lexik:jwt:generate-keypair
``` ```
4. Run database migrations: 4. Run database migrations
```shell ```shell
php bin/console doctrine:migrations:migrate php bin/console doctrine:migrations:migrate
``` ```
5. Start the Symfony server: 5. Start the Symfony server
```shell ```shell
symfony server:start symfony server:start
``` ```
6. Build assets: 6. Build assets
```shell ```shell
php bin/console assets:install php bin/console assets:install
``` ```
@@ -62,28 +62,30 @@ git clone https://github.com/maelgangloff/domain-watchdog.git
#### Frontend #### Frontend
<Steps> <Steps>
1. Install dependencies: 1. Install dependencies
```shell ```shell
yarn install yarn install
``` ```
2. Generate language files: 2. Generate language files
```shell ```shell
yarn run ttag:po2json yarn run ttag:po2json
``` ```
3. Make the final build: 3. Make the final build
```shell ```shell
yarn build yarn build
``` ```
4. Add and modify the following files as you wish: 4. Add and modify the following files as you wish
~~~ <FileTree>
public/content/home.md - public
public/content/privacy.md - content
public/content/tos.md - home.md
public/content/faq.md - privacy.md
public/images/icons-512.png - tos.md
public/images/banner.png - faq.md
public/favicon.ico - icons-512.png
~~~ - banner.png
- favicon.ico
</FileTree>
</Steps> </Steps>
## Update ## Update
@@ -99,19 +101,19 @@ git pull origin master
### Backend ### Backend
<Steps> <Steps>
1. Install dependencies: 1. Install dependencies
```shell ```shell
composer install composer install
``` ```
2. Run database migrations: 2. Run database migrations
```shell ```shell
php bin/console doctrine:migrations:migrate php bin/console doctrine:migrations:migrate
``` ```
3. Clearing the Symfony cache: 3. Clearing the Symfony cache
```shell ```shell
php bin/console cache:clear php bin/console cache:clear
``` ```
4. Build assets: 4. Build assets
```shell ```shell
php bin/console assets:install php bin/console assets:install
``` ```
@@ -120,15 +122,15 @@ git pull origin master
### Frontend ### Frontend
<Steps> <Steps>
1. Install dependencies: 1. Install dependencies
```shell ```shell
yarn install yarn install
``` ```
2. Generate language files: 2. Generate language files
```shell ```shell
yarn run ttag:po2json yarn run ttag:po2json
``` ```
3. Make the final build: 3. Make the final build
```shell ```shell
yarn build yarn build
``` ```