|
|
@@ -0,0 +1,26 @@ |
|
|
|
# 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: |
|
|
|
```bash |
|
|
|
$ git clone https://github.com/Foltik/Shimapan |
|
|
|
``` |
|
|
|
|
|
|
|
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 |
|
|
|
``` |