Skip to content

Repository files navigation



GAGU (Alpha)

Website: https://gagu.jsw.im

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 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:
  1. Sync dependencies in ./gagu-back-end/package.json to ./package.json.

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

  3. Dry run publish, update package size info and Changelog date, publish to NPM.

⭐️ Star History

Star History Chart

📜 License

The MIT license.

About

A web-based file management system

Topics

Resources

Stars

84 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages