foltik/shimapan
1
0
Fork 0
mirror of https://github.com/Foltik/Shimapan synced 2024-09-21 03:09:15 -04:00
Code Issues Releases Wiki Activity
A simple file sharing site with an easy to use API and online panel.
78 Commits 2 Branches 0 Tags 29 MiB
JavaScript 87.5%
HTML 6.9%
CSS 5.6%
16c44381aa
Go to file
Jack Foltz 16c44381aa Add link to CONTRIBUTING.md in README.md
2017-10-20 20:41:11 -04:00
app Rework directory structure 2017-10-20 16:46:14 -04:00
config Work on stuff 2017-10-18 13:31:08 -04:00
public Removed build files 2017-10-20 17:46:24 -04:00
test Delete extraneous README.md 2017-10-20 17:40:18 -04:00
.gitignore Ignore build directories 2017-10-20 17:42:45 -04:00
CONTRIBUTING.md Create CONTRIBUTING.md 2017-10-20 17:37:25 -04:00
gulpfile.js Add scripts for nodemon 2017-10-20 17:43:19 -04:00
LICENSE Create LICENSE 2017-10-20 17:35:33 -04:00
package-lock.json Ignore build directories 2017-10-20 17:42:45 -04:00
package.json Merge pull request #9 from Foltik/mean 2017-10-20 17:49:25 -04:00
README.md Add link to CONTRIBUTING.md in README.md 2017-10-20 20:41:11 -04:00
server.js Rework directory structure 2017-10-20 16:46:14 -04:00

README.md

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.