new version without npm
This commit is contained in:
parent
93f4b3bc50
commit
44d5347bbf
26
readme.md
26
readme.md
|
@ -34,39 +34,19 @@ You should sign up for the chat and you will be notified about issues and bugfix
|
||||||
<?php print imap_base64("SU1BUCBleHRlbnNpb24gc2VlbXMgdG8gYmUgaW5zdGFsbGVkLiA="); ?>
|
<?php print imap_base64("SU1BUCBleHRlbnNpb24gc2VlbXMgdG8gYmUgaW5zdGFsbGVkLiA="); ?>
|
||||||
|
|
||||||
2. clone or download this repository
|
2. clone or download this repository
|
||||||
3. copy the `dist` directory to your web server.
|
3. copy the `src` directory to your web server.
|
||||||
4. rename `config.sample.php` to `config.php` and apply the imap settings. Move `config.php` to a safe location outside the `public_html`.
|
4. rename `config.sample.php` to `config.php` and apply the imap settings. Move `config.php` to a safe location outside the `public_html`.
|
||||||
5. open `backend.php` and set the new path to `config.php`.
|
5. open `backend.php` and set the new path to `config.php`.
|
||||||
|
|
||||||
|
|
||||||
## Build it yourself
|
## Build it yourself
|
||||||
Instead of using the files in the `dist` directory you can also build it yourself. You must have [npm](https://docs.npmjs.com/cli/install) and [composer](https://getcomposer.org/download/) installed.
|
The src directory contains all required files. If you want to update the php dependencies, you can update them yourself. You must have [composer](https://getcomposer.org/download/) installed. See also `build.sh`.
|
||||||
The files are written to the `dist` directory. See also `build.sh`.
|
|
||||||
|
|
||||||
|
|
||||||
Install php dependecies:
|
Install php dependecies:
|
||||||
|
|
||||||
composer install
|
composer install
|
||||||
|
|
||||||
Copy backend files:
|
|
||||||
|
|
||||||
cp -rv src/{backend.php,config.sample.php} dist/
|
|
||||||
|
|
||||||
Install javascript dependencies:
|
|
||||||
|
|
||||||
npm install
|
|
||||||
|
|
||||||
Build frontend:
|
|
||||||
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
Run frontend with development server:
|
|
||||||
|
|
||||||
npm start
|
|
||||||
|
|
||||||
|
|
||||||
There is a [Vagrantfile](Vagrantfile), in case you are familiar with [vagrant](https://www.vagrantup.com/).
|
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
1. setup a link redirection provider (to keep the existence of your installation secret)
|
1. setup a link redirection provider (to keep the existence of your installation secret)
|
||||||
2. provide error message if config.php is missing or in a public folder.
|
2. provide error message if config.php is missing or in a public folder.
|
||||||
|
@ -78,4 +58,4 @@ This could not be possible without...
|
||||||
* http://angularjs.org/
|
* http://angularjs.org/
|
||||||
* https://github.com/barbushin/php-imap
|
* https://github.com/barbushin/php-imap
|
||||||
* https://github.com/gregjacobs/Autolinker.js/
|
* https://github.com/gregjacobs/Autolinker.js/
|
||||||
* https://github.com/TomFrost/node-phonetic
|
* https://github.com/TomFrost/node-phonetic
|
||||||
|
|
Loading…
Reference in New Issue
Block a user