This repository has been archived on 2022-02-10. You can view files and clone it, but cannot push or open issues or pull requests.
filespread/README.md
Marcel Kapfer (mmk2410) b5303781d6 Updated readme
2016-11-21 18:09:05 +01:00

52 lines
983 B
Markdown

# Filespread
Filespread is a simple webapp to make file spreading over mail easy by providing the ability to manage different templates and different address lists.
## Installation
Fork the git repo and run
```
npm install
```
```
composer install
```
Make sure you have gulp installed on your system and run
```
gulp sass
```
```
gulp coffee
```
Make sure you have dart installed on your system and run
```
cd res/dart/
```
```
dart2js -m -o main.js main.dart
```
Create the folders `templates`, `assets` and `lists` and make sure that the server can write in these folders.
Finally remove the example files.
# License
Filespread is licensed under the MIT license.
# Contributing
1. Fork it
2. Create a feature branch with a meaningful name (`git checkout -b my-new-feature`)
3. Add yourself to the CONTRIBUTORS file
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to your branch (`git push origin my-new-feature`)
6. Create a new pull request