From 5401381de86e4717662533e26039131d54bf94eb Mon Sep 17 00:00:00 2001 From: perennial Date: Mon, 23 Sep 2024 14:27:05 +1000 Subject: [PATCH] Rename to build.sh --- Dockerfile | 2 +- README.md | 4 ++-- manage.sh => build.sh | 2 +- doc/dev/guidelines.md | 2 +- doc/hosting/hosting-pixivfe.md | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) rename manage.sh => build.sh (99%) diff --git a/Dockerfile b/Dockerfile index c356c21..db1c1b1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -9,7 +9,7 @@ COPY . . # Build the application RUN --mount=type=cache,target=/root/.cache/go-build \ --mount=type=cache,target=/go/pkg \ - ./manage.sh build + ./build.sh build # Stage for creating the non-privileged user FROM alpine:3.20 AS user-stage diff --git a/README.md b/README.md index 45bb6c0..154e59c 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,12 @@ Then, run the project: git clone https://codeberg.org/VnPower/PixivFE.git && cd PixivFE # Run PixivFE in development mode (styles and templates reload automatically) -PIXIVFE_DEV=1 ./manage.sh run +PIXIVFE_DEV=1 ./build.sh run ``` ## Hosting PixivFE -You can use PixivFE for personal use! Assuming that you use an operating system that can run POSIX shell scripts, install `go`, clone this repository, and use the `manage.sh` shell script to build and run the project. +You can use PixivFE for personal use! Assuming that you use an operating system that can run POSIX shell scripts, install `go`, clone this repository, and use the `build.sh` shell script to build and run the project. I recommend self-hosting your own instance for personal use, instead of relying entirely on official instances. To deploy PixivFE using Docker or the compiled binary, see [Hosting PixivFE](https://pixivfe-docs.pages.dev/hosting-pixivfe/). diff --git a/manage.sh b/build.sh similarity index 99% rename from manage.sh rename to build.sh index 18a69bd..1676879 100755 --- a/manage.sh +++ b/build.sh @@ -102,7 +102,7 @@ execute_command() { # Main execution if [ $# -eq 0 ]; then - help + build else execute_command "$@" fi diff --git a/doc/dev/guidelines.md b/doc/dev/guidelines.md index 01718fe..08f26a0 100644 --- a/doc/dev/guidelines.md +++ b/doc/dev/guidelines.md @@ -29,7 +29,7 @@ This file contains guidelines for code development. ## Adding features -- Edit the `manage.sh` if you want to create scripts that help with the process of developing and/or using PixivFE. +- Edit the `build.sh` if you want to create scripts that help with the process of developing and/or using PixivFE. - Don't create or add any shell files or configuration files of external programs in the root directory unless necessary. - Add comments where necessary to explain complex logic or non-obvious code behavior. diff --git a/doc/hosting/hosting-pixivfe.md b/doc/hosting/hosting-pixivfe.md index 4607f26..6c6c139 100644 --- a/doc/hosting/hosting-pixivfe.md +++ b/doc/hosting/hosting-pixivfe.md @@ -112,12 +112,12 @@ Copy `.env.example` to `.env` and configure the variables as needed. Refer to th ### 3. Building and running PixivFE -PixivFE provides a shell script named `manage.sh` to simplify the build and run process. +PixivFE provides a shell script named `build.sh` to simplify the build and run process. To build and run PixivFE, use the following commands: ```bash -./manage.sh run +./build.sh run ``` This will build the PixivFE binary and start it. It will be accessible at `localhost:8282`.