📦 Getting started

GAGU is published on NPM, so install Node.js on your device first.

You need to install ffmpeg and GraphicsMagick to support thumbnail api.

# Install with NPM
$ npm i -g gagu

# Show help info
$ gagu -h

Default admin account:

Username: gagu
Password: 9293

Docs here

🛠 Development

Only the pnpm-lock.yaml file is uploaded in the project, so using pnpm instead of npm to install dependencies can ensure that our running results in the development environment are consistent.

# install dependencies
pnpm i

GAGU app code consists of two parts: ./gagu-back-end and ./gagu-front-end.

# Back-end
$ cd gagu-back-end
$ pnpm start:dev

# Front-end
$ cd gagu-front-end
$ pnpm start

GAGU website code is in ./gagu-website.

$ cd gagu-website
$ pnpm start

🔨 Build NPM package

1. Update following version info:

• version field in ./package.json
• GAGU_VERSION in ./gagu-back-end/src/shared/utils/constant.util.ts

2. Sync dependencies in ./gagu-back-end/package.json to ./package.json.

3. Run build script npm run build:npm, refer to ./build-npm.sh.

4. Dry run publish, update package size info, publish to NPM.

⭐️ Star History

📜 License

The MIT license.