Skip to content

Commit 8263ea3

Browse files
committed
Updated README with all the getting started info. Does not include JSON reference/dictionary.
1 parent 196bd69 commit 8263ea3

File tree

1 file changed

+57
-2
lines changed

1 file changed

+57
-2
lines changed

README.md

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,61 @@
11
angular-forms
22
=============
33

4-
Form generator for Angular JS. Represent an HTML form as a Javascript object and let angular-forms generate, compile and inject an Angular JS form into your app.
4+
Turn forms into reusable JSON objects. With angular-forms.js you can concentrate on building your app and not all the bits that go into creating and validating forms. Let angular-forms.js generate the HTML, CSS and angular direcives for you.
5+
6+
Generated forms are built with Twitter Bootstrap elements baked in, so you don't even have to think about styling. Indicate the desired form style, basic or horizontal, in the JSON from definition, and the form is generated accordingly.
7+
8+
Requirements
9+
============
10+
11+
* [AngularJS 1.2.6+](http://www.angularjs.org)
12+
* [Twitter Bootstrap 3.0.3+](http://www.getbootstrap.com)
13+
* [FontAwesome
14+
15+
Note that Angular-forms.js is being developed with the latest stable versions of any required packages. It is quite possible that earlier version will work just fine.
16+
17+
Installation
18+
============
19+
20+
The recommended way to add the required items and angular-forms.js to your project is to use [bower](http://www.bower.io).
21+
22+
Steps to install with bower:
23+
24+
bower install angular
25+
bower install bootstrap
26+
bower install angular-forms.js
27+
bower install components-font-awesome
28+
29+
Add the follwing stylesheets and scripts to your app:
30+
31+
<link rel="stylesheet" href="/bower_components/bootstrap/dist/css/bootstrap.min.css" />
32+
<link rel="stylesheet" href="/bower_components/components-font-awesome/css/font-awesome.min.css" />
33+
<script src="/bower_components/angular/angular.min.js"></script>
34+
<script src="/angular-forms.min.js"></script>
35+
36+
Note the above script and link element examples assume bower was used for installation and that packages were installed in bower_components. If that is not the case, adjust accordingly.
37+
38+
Sample Application
39+
==================
40+
41+
A sample application is included to provide a getting started example as well as aid in development. To use the sampe app, clone the angular-forms.js repo, install dependencies, and run the included web server:
42+
43+
cd ~/projects
44+
git clone [email protected]:chouseknecht/angular-forms.js.git
45+
cd angular-forms.js
46+
bower install
47+
48+
Start the web server:
49+
50+
cd ~/projects/angular-forms.js
51+
./scripts/web-server.js
52+
53+
Point your browser to: http://localhost:8000/app/index.html
54+
55+
Contributing
56+
============
57+
58+
At the moment there are no tests. They will be added shortly. In the meantime, install the sample app, as detailed above, and add new features or changes to the sample app and demonstrate that things are working as expected.
59+
60+
561

6-
Currently under development. Expect breakage!

0 commit comments

Comments
 (0)