foltik/shimapan
1
0
Fork 0
mirror of https://github.com/Foltik/Shimapan synced 2024-11-10 15:48:27 -05:00
Code Issues Releases Wiki Activity
A simple file sharing site with an easy to use API and online panel.
202 Commits 2 Branches 0 Tags 29 MiB
JavaScript 87.5%
HTML 6.9%
CSS 5.6%
72f4f53f39
Go to file
Jack Foltz 72f4f53f39
Update README.md
2018-08-13 11:36:22 -04:00
app Fix key limit check and add test 2018-08-13 06:13:47 -04:00
config Add code coverage 2018-08-13 06:53:21 -04:00
public Add unit shortening to users page 2018-01-15 18:14:37 -05:00
test Add user not found tests for ban/unban 2018-08-13 06:23:46 -04:00
.gitignore Add nyc output to .gitignore 2018-08-01 20:26:24 -04:00
.travis.yml Add npm ci 2018-08-13 07:27:17 -04:00
CONTRIBUTING.md Create CONTRIBUTING.md 2017-10-20 17:37:25 -04:00
gulpfile.js Update gulpfile for gulp 4.0.0 2018-07-24 19:39:34 -04:00
LICENSE Create LICENSE 2017-10-20 17:35:33 -04:00
package-lock.json Fix istanbul version for travis-ci 2018-08-13 07:10:01 -04:00
package.json Fix istanbul version for travis-ci 2018-08-13 07:10:01 -04:00
README.md Update README.md 2018-08-13 11:36:22 -04:00
server.js Remove unhandled exception handler 2018-08-13 07:18:48 -04:00

README.md

Build Status Coverage Status

Shimapan

Shimapan is an easy to use file sharing website. It's easy to integrate shimapan 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/Shimapan

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.