Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/optional fields #11

Open
wants to merge 4 commits into
base: feat/optional-fields
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# ngx-api-orm
Also lovingly called NAO
# NAO (ngx-api-orm)
Some links to get you started:
* [API Documentation](https://maurei.github.io/ngx-api-orm/).
* [NPM Package](https://www.npmjs.com/package/@ngx-api-orm/json-api)

The NPM packages:

* [Core package](https://www.npmjs.com/package/@ngx-api-orm/core) - This is the default package needed to start
* Optional packages:
* [Json:api implementation](https://www.npmjs.com/package/@ngx-api-orm/json-api)

**Note: docs are still under construction.**

A rest api Object Relationship Mapper (ORM) for Angular. Tested with Angular 6.1.x. Can be use used seamlessly with [JSON:api](JsonApi.org) or easibly be adjusted to work with your own format.
A rest API Object Relationship Mapper (ORM) for Angular. Tested with Angular 6.1.x. Can be used seamlessly with [JSON:api](JsonApi.org) or easily be adjusted to work with your own format.

It's aim is to remove as much boilerplate code as possible while allowing for easy extendability. It will empower your models with CRUD functionality and also manages to-one and to-many relationships.

Expand Down Expand Up @@ -92,8 +96,9 @@ To get started you need the following:
Using NPM (link to package [here](https://www.npmjs.com/package/@ngx-api-orm/json-api)):
```console
npm install --save @ngx-api-orm/core
npm install --save @ngx-api-orm/json-api
```
If you wish to install a specific version, you can use the following format:
If you wish to install a specific version, you can use the following format (if you would like to use 0.0.1-beta6 of the core package)
```console
npm install --save @ngx-api-orm/[email protected]
```
Expand Down
4 changes: 4 additions & 0 deletions core/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions ngx-api-orm.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"folders": [
{
"path": "."
}
]
}