Commit 45e299d6 authored by thiaramus's avatar thiaramus
Browse files

Cleaned-up readme.md, hoping to fill it up with the API docs in the future :)

parent 6b5207ae
# webJAM
# jameditor-api
## WARNING!
**This is at a very early stage of development!**
Based on webJAM by Philipp Giebel
You can use webJAM in readonly mode (enabled by default) relatively safe.
Write mode has proven to still be a mess and you should only enable it, if you know what you're doing...
There's absolutely no guarantee this won't blow up your messagebase, so **do backups!**
https://gitlab.ambhost.net/stimpy/website_jamreader
## Introduction
webJAM is a JAM Messagebase editor for the web in 2018.
JAM is an ancient messagebase format used for ftn networks like FidoNet.
While using oldschool editors like GoldED or a telnet BBS is great for the nostalgia kicks, I long wished for a modern alternative. Something better matching my daily workflow and habits. Something for the web. With Ajax and stuff.. ...And so I started writing this.. :)
### Website & Screenshots
<https://kuehlbox.wtf/webjam>
### Demo
<https://kuehlbox.wtf/demo>
**user:** demo
**pass:** demo
## Requirements
* PHP7
* A JAM Messagebase, obviously...
* A modern Webbrowser with JavaScript enabled.
While there is fallback code, that once worked, it doesn't at the moment. This will be repaired in the future so javascript becomes optional again.. Right now, it's mandatory.
## Configuration & Installation
1. Edit these two files to match your needs and rename them:
* dist/assets/include/config.inc.php.dist => dist/assets/include/config.inc.php
* dist/assets/include/areas.ini.dist => dist/assets/include/areas.ini
You can use *dist/bin/husky2ini.php* to automatically create a suitable *areas.ini* for webJAM based on your husky configuration.
2. Upload contents of the folder "*dist/*" to your webspace.
### Updating:
Simply upload the contents of the folder "*dist/*" and overwrite all existing files. No configuration files will be overwritten.
You should always have a look at the updated "*dist/assets/include/config.inc.php.dist*" and manually add newly introduced variables to your existing configuration at "*dist/assets/include/config.inc.php*"
## Support
As of now, support is only available using this website.
[Please register an account](https://gitlab.ambhost.net/users/sign_in) to [file issues and requests](https://gitlab.ambhost.net/stimpy/website_jamreader/issues/new).
## Development
If you'ld like to participate even more with this project, you're very welcome!
Please [fork your own version](https://gitlab.ambhost.net/stimpy/website_jamreader/forks/new) and [send merge-request](https://gitlab.ambhost.net/stimpy/website_jamreader/merge_requests/new) for the outcomings.
### Development dependencies
* [npm](https://www.npmjs.com/)
* [bower](https://bower.io/)
* [grunt](https://gruntjs.com/)
* (optional) The IDE, I used, is [NetBeans](https://netbeans.org/). All project files are included.
### Development first steps
1. npm install
2. bower install
3. All development is done inside the folder "*src/*".
4. To export distribution files to the folder "*dist/*", run "*grunt default*".
## License
Copyright (C) 2018 Philipp Giebel <stimpy (ÄT) kuehlbox.wtf>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
### 3rd party software used
* [JQuery](http://jquery.com/)
* [Bootstrap](http://getbootstrap.com/)
* [Crypto-JS](https://github.com/brix/crypto-js)
* [HTML5 Shiv](https://github.com/aFarkas/html5shiv)
* [ie10-viewport-bug-workaround](https://github.com/jdrda/ie10-viewport-bug-workaround)
* [respond.js](https://github.com/scottjehl/Respond)
\ No newline at end of file
Readme is yet to come.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment