GAGU (Alpha)

Website: gagu.io

A web-based file management system

Manage files on your different devices in the browser

Works on Windows, macOS, Linux and Android/Termux

Inspired by Android/X-plore and NPM/anywhere

📦 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:

Username: gagu
Password: 9293

Docs here

🛠 Development

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

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

# Font-end
$ cd gagu-front-end
$ yarn
$ yarn start

GAGU website code is in ./gagu-website.

$ cd gagu-website
$ yarn
$ yarn start

🔨 Build NPM package

1. Update following version tags:

• GAGU_VERSION in gagu/gagu-back-end/src/utils/constant.util.ts
• version field in gagu/package.json
• version tag in gagu/README.md
• version field in gagu/gagu-website/.env

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

3. Run build script yarn build:bin, refer to ./build.sh.

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

📜 License

The MIT license.