Skip to content

Commit

Permalink
Add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
manuquentin committed Apr 16, 2015
1 parent a12b48a commit e699342
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ module.exports = function (grunt) {
json_server: {
stub: {
options: {
port: 3002,
port: 3000,
db: 'examples/blog/stub-server.json',
keepalive: false
}
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ Your application should use a `ui-view`:
<div ui-view></div>
```

### Dependency-less Version

ng-admin is also available without compiled dependencies : `bower_components/ng-admin/build/ng-admin-only.min.js`.
Please refer to the `examples/blog/index-deps.html` file to get the list of required dependencies to include.

## Example Configuration

We chose to define the entities & views directly in JavaScript to allow greater freedom in the configuration.
Expand Down
4 changes: 2 additions & 2 deletions examples/blog/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@
});

var admin = nga.application('ng-admin backend demo') // application main title
.baseApiUrl('http://localhost:3002/'); // main API endpoint
.baseApiUrl('http://localhost:3000/'); // main API endpoint

// define all entities at the top to allow references between them
var post = nga.entity('posts'); // the API endpoint for posts will be http://localhost:3000/posts/:id

var comment = nga.entity('comments')
.baseApiUrl('http://localhost:3002/') // The base API endpoint can be customized by entity
.baseApiUrl('http://localhost:3000/') // The base API endpoint can be customized by entity
.identifier(nga.field('id')); // you can optionally customize the identifier used in the api ('id' by default)

var tag = nga.entity('tags')
Expand Down
18 changes: 13 additions & 5 deletions examples/blog/stub-server.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@
"tags": [
1,
3
]
],
"category": "tech",
"subcategory": "computers"
},
{
"id": 2,
Expand Down Expand Up @@ -148,7 +150,10 @@
"tags": [
4,
3
]
],
"category": "tech",
"subcategory": "computers",
"pictures": null
},
{
"id": 12,
Expand All @@ -157,7 +162,10 @@
"body": "<p>Praesentium corrupti minus molestias eveniet mollitia. Sit dolores est tenetur eos veritatis. Vero aut molestias provident ducimus odit optio.</p><p>Minima amet accusantium dolores et. Iste eos necessitatibus iure provident rerum repellendus reiciendis eos. Voluptate dolorem dolore aliquid sed maiores.</p><p>Ut quia excepturi quidem quidem. Cupiditate qui est rerum praesentium consequatur ad. Minima rem et est. Ut odio nostrum fugit laborum. Quis vitae occaecati tenetur earum non architecto.</p><p>Minima est nobis accusamus sunt explicabo fuga. Ut ut ut officia labore ratione animi saepe et.</p><p>Accusamus quae ex rerum est eos nesciunt et. Nemo nam consequatur earum necessitatibus et. Eum corporis corporis quia at nihil consectetur accusamus. Ea eveniet et culpa maxime.</p><p>Et et quisquam odio sapiente. Voluptas ducimus beatae ratione et soluta esse ut animi. Ipsa architecto veritatis cumque in.</p><p>Voluptatem dolore sint aliquam excepturi. Pariatur quisquam a eum. Aut et sit quis et dolorem omnis. Molestias id cupiditate error ab.</p><p>Odio ut deleniti incidunt vel dolores eligendi. Nemo aut commodi accusamus alias reprehenderit dolorum eaque. Iure fugit quis occaecati aspernatur tempora iste.</p><p>Omnis repellat et sequi numquam accusantium doloribus eum totam. Ab assumenda facere qui voluptate. Temporibus non ipsa officia. Corrupti omnis ut dolores velit aliquam ut omnis consequuntur.</p><p>Et et non dolores itaque nesciunt reiciendis fuga quod. Quia voluptate repellat consequatur cupiditate et sint quis.</p><p>Quidem est nihil odit deleniti ab. Perspiciatis odit modi et aut et dolor.</p><p>Architecto velit et ipsam deserunt. Nostrum non fuga voluptatibus dolore rerum. Vitae consequuntur qui dolor laborum.</p><p>Atque iusto neque voluptatem aut neque. Necessitatibus at quas consectetur rerum ipsum. Et ullam aut velit.</p><p>Ad et nobis voluptatem et voluptatem cum facilis unde. Qui qui ratione dolores necessitatibus doloribus. Tempore aut consequatur ea optio. Eaque sunt recusandae expedita quaerat excepturi. Autem ipsum aliquid at porro perspiciatis.</p><p>Enim magni voluptatibus sunt et quos facilis recusandae id. Voluptatem autem exercitationem ut maxime eaque corporis aut. Vel quas accusamus voluptatem est odio. Officiis temporibus iusto corporis quos sed non qui.</p><p>Architecto aut assumenda assumenda doloremque enim et. Aut totam alias sint ipsa. Nihil aut alias pariatur minus aut eos ut.</p><p>Vitae aut velit illum natus. Animi error nemo veritatis natus. Vel nulla veniam consequatur consequatur laboriosam incidunt minima. Id rem accusamus voluptatum modi et aut et.</p><p>Excepturi corporis omnis ipsam ipsam praesentium ipsa. Voluptas qui deleniti iusto mollitia vitae sequi. Dicta vero et eveniet delectus asperiores voluptatum ratione. Distinctio porro sunt qui ea.</p><p>Dignissimos tempora atque quaerat doloribus repellendus molestias eveniet. Consectetur sunt adipisci voluptate enim in. Rerum non ut optio nam nostrum est. Tempora et nihil sit pariatur. Eius minima sit earum sed alias vero dolorem.</p><p>Dolor deleniti ipsum et odit in laboriosam repellat consequatur. Et ipsum tenetur ipsum ut debitis quo. Sunt inventore aut tenetur eum facilis qui adipisci. Praesentium rerum occaecati nulla.</p><p>Voluptatem dignissimos odio repudiandae. Id et ut ut id nisi. Occaecati omnis blanditiis temporibus nobis nesciunt corrupti.</p><p>Eligendi cumque alias blanditiis est. Eum aperiam dolore iste. Qui velit eos voluptas ea quidem. Quia natus pariatur doloremque velit accusamus.</p><p>Aliquid quidem assumenda autem fuga corporis rerum. Qui aut officia voluptatem voluptas maxime molestias. Nostrum ab quasi et blanditiis iusto esse.</p><p>Rem expedita non sequi. Itaque molestiae et non tempore corrupti ullam quisquam modi. Ex in maxime architecto consequuntur minima quaerat voluptatem. Omnis est eius accusantium et ipsum dolore.</p><p>Suscipit harum aut eveniet saepe reprehenderit. Ipsa eaque distinctio nulla nam libero. Debitis architecto quasi quia magnam quia.</p><p>Fugit dolorum illum aut molestiae neque. Delectus non voluptate vero est debitis id. Vitae distinctio iste omnis aspernatur voluptatem vero. Quaerat recusandae rem repellat.</p><p>Dolorum praesentium voluptas et omnis qui commodi laborum. Dolorem nostrum repellat facilis consectetur ex. Repudiandae iusto quia numquam. Reprehenderit sint beatae error non.</p><p>Recusandae in eius quos et voluptas. Doloremque consequuntur laudantium vel nihil. Eligendi quis aut ducimus numquam.</p><p>Doloribus ea maxime voluptatem sit. Et ullam quo rerum quia necessitatibus sed impedit.</p><p>Facilis quisquam et sunt. Eum officiis dolorem enim sapiente voluptatem sunt. Eum sit quidem culpa veniam sit.</p><p>Excepturi saepe alias ut rerum. Non autem hic dignissimos vel quo qui quas unde. Unde ut minus id architecto.</p><p>Eveniet ipsum et non error et nemo. Magnam voluptates dolore tenetur velit deserunt cupiditate ut. Voluptas rerum sed aut distinctio. Eligendi quis id molestiae.</p><p>Voluptatem adipisci et est voluptatibus repudiandae molestiae distinctio. Quisquam enim aliquid veritatis. Iure eos velit quod commodi fugit molestiae.</p><p>Consequuntur et velit quia et deserunt officia ut. Pariatur et atque ut nulla saepe cum veritatis. Qui praesentium praesentium quos consequatur.</p>",
"views": 720,
"published_at": "2012-11-07",
"tags": []
"tags": [],
"category": "lifestyle",
"subcategory": "fitness",
"pictures": null
}
],
"comments": [
Expand Down Expand Up @@ -235,7 +243,7 @@
"id": 11,
"post_id": 1,
"author": "Logan Schowalter",
"body": "I don't want to be?' it asked. 'Oh, I'm not Ada,' she said, 'and see whether it's <i><b>marked</b></i> \"poison\" or not'; for she had asked it aloud; and in despair she put her hand on the end of the.",
"body": "I don't want to be?' it asked. 'Oh, I'm not Ada,' she said, 'and see whether it's marked \"poison\" or not'; for she had asked it aloud; and in despair she put her hand on the end of the.",
"created_at": "2012-08-05"
}
],
Expand Down Expand Up @@ -266,4 +274,4 @@
"published": 1
}
]
}
}

0 comments on commit e699342

Please sign in to comment.