shimapan/README.md

Shrimpa

Shrimpa is an easy to use file sharing website. It's easy to integrate shrimpa into most 3rd party utilities with the use of its RESTful API. The web panel gives users the means to manage their uploaded content and various other useful utilities.

Installation

Clone the latest release locally:

$ git clone https://github.com/Foltik/Shrimpa

Next, install dependencies and build into public/ with npm:

$ npm install
$ npm run build

Finally, start the Node.js server with:

$ npm start

Or optionally, monitor the source files, rebuilding and restarting the server whenever changes are made with nodemon for easy live development:

$ npm run watch

Other Notes

In order to contribute, please read the Contributing file.