2018-08-13 11:36:22 -04:00
|
|
|
[![Build Status][build-image]][build-url] [![Coverage Status][coverage-image]][coverage-url]
|
2021-11-08 22:46:45 -05:00
|
|
|
# Shrimpa
|
|
|
|
|
Shrimpa is an easy to use file sharing website. It's easy to integrate shrimpa into
|
2017-10-20 17:32:04 -04:00
|
|
|
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:
|
|
|
|
|
```bash
|
2021-11-08 22:46:45 -05:00
|
|
|
$ git clone https://github.com/Foltik/Shrimpa
|
2017-10-20 17:32:04 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Next, install dependencies and build into `public/` with `npm`:
|
|
|
|
|
```bash
|
|
|
|
|
$ npm install
|
|
|
|
|
$ npm run build
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Finally, start the Node.js server with:
|
|
|
|
|
```bash
|
|
|
|
|
$ npm start
|
|
|
|
|
```
|
|
|
|
|
Or optionally, monitor the source files, rebuilding and restarting the server
|
|
|
|
|
whenever changes are made with `nodemon` for easy live development:
|
|
|
|
|
```bash
|
|
|
|
|
$ npm run watch
|
|
|
|
|
```
|
2017-10-20 20:41:11 -04:00
|
|
|
|
|
|
|
|
## Other Notes
|
|
|
|
|
In order to contribute, please read the [Contributing](CONTRIBUTING.md) file.
|
2018-08-13 11:36:22 -04:00
|
|
|
|
2021-11-08 22:46:45 -05:00
|
|
|
[build-image]: https://travis-ci.com/Foltik/Shrimpa.svg?branch=master
|
|
|
|
|
[build-url]: https://travis-ci.com/Foltik/Shrimpa
|
2018-08-13 11:36:22 -04:00
|
|
|
|
2021-11-08 22:46:45 -05:00
|
|
|
[coverage-image]: https://img.shields.io/codecov/c/github/Foltik/shrimpa/master.svg
|
|
|
|
|
[coverage-url]: https://codecov.io/gh/Foltik/Shrimpa
|
