# 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
```

## Contributing
### Objectives
Head over to the [projects page](https://github.com/Foltik/Shimapan/projects/). Here you'll find all the current
and upcoming objectives of the current project. If you have any ideas or suggestions, add it to the relevant
column in the project page and create an issue to discuss.
### Finding Work
After reviewing the to-do list in the project page, taking note of priority, head to the issues page and assign yourself
to one you would like to work on.
### Contributing Changes
Create a branch for your changes and commit them. Once you are done, create a pull request for review, 
and the changes will be merged into the master branch.