tellform/README.md

88 lines
2.9 KiB
Markdown
Raw Normal View History

2015-07-09 22:15:34 +00:00
MEDFORMS
--------
2015-06-29 22:51:29 +00:00
2015-07-27 19:02:10 +00:00
[![Build Status](https://travis-ci.org/whitef0x0/medforms.svg?branch=master)](https://travis-ci.org/whitef0x0/medforms)
2015-07-27 20:37:08 +00:00
[![Dependencies Status](https://david-dm.org/whitef0x0/medforms.svg)](https://david-dm.org/whitef0x0/medforms)
2015-06-29 22:51:29 +00:00
2015-07-09 22:15:34 +00:00
Medforms is an opensource *form builder* that can create stunning forms from PDFs or from scratch
2015-06-29 22:51:29 +00:00
2015-07-09 22:15:34 +00:00
## Quickstart
2015-06-29 22:51:29 +00:00
2015-07-09 22:15:34 +00:00
Install dependencies first.
2015-06-29 22:51:29 +00:00
```bash
$ npm install
2015-07-09 22:15:34 +00:00
$ bower install
2015-06-29 22:51:29 +00:00
```
2015-08-21 01:03:05 +00:00
To run development version:
```bash
$ grunt default
```
To run production version:
2015-06-29 22:51:29 +00:00
```bash
2015-08-21 01:03:05 +00:00
$ grunt production
2015-06-29 22:51:29 +00:00
```
Your application should run on port 3000, so in your browser just go to [http://localhost:3000](http://localhost:3000)
## Testing Your Application
You can run the full test suite included with MEAN.JS with the test task:
```
$ grunt test
```
This will run both the server-side tests (located in the app/tests/ directory) and the client-side tests (located in the public/modules/*/tests/).
To execute only the server tests, run the test:server task:
```
$ grunt test:server
```
And to run only the client tests, run the test:client task:
```
$ grunt test:client
```
2015-07-30 00:42:55 +00:00
Currently the live example uses heroku github deployments. The Docker file is out of date and does not work. If someone wishes to get it working feel free to submit a pull request.
2015-06-29 22:51:29 +00:00
## Running in a secure environment
To run your application in a secure manner you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:
```bash
$ sh ./scripts/generate-ssl-certs.sh
```
Windows users can follow instructions found [here](http://www.websense.com/support/article/kbarticle/How-to-use-OpenSSL-and-Microsoft-Certification-Authority).
After you've generated the key and certificate, place them in the *config/sslcerts* folder.
## Credits
2015-07-09 22:15:34 +00:00
Inspired/built off great work of the meanjs team [MeanJS](https://github.com/mean/)
2015-06-29 22:51:29 +00:00
## License
(The MIT License)
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.