ngx-drupal8-rest

A wrapper library to connect to a Drupal8 based backend

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.14.17
v16.17.1

Table of contents

• Project Name
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • Usage
    • Serving the app
    • Running the tests
    • Building a distribution version
    • Serving the distribution version
  • Contributing
  • Credits
  • Built With
  • Versioning
  • Authors
  • License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

For integrating on your project

$ npm i @makiwin/ngx-drupal8-rest

BEFORE YOU INSTALL: please read the prerequisites

For contribuiting to the project

Start with cloning this repo on your local machine:

$ git clone https://github.com/Makiwin/ngx-drupal8-rest
$ cd ngx-drupal8-rest

To set up the library:

$ npm install 

Or if you prefer using Yarn:

$ yarn install

Usage

Serving the library

$ npm run watch:dev
$ cd dist/ngx-drupal8-rest
$ npm link

Using the library on your application

go to the main folder of your application and type this command

$ npm link ngx-drupal8-rest

Building a distribution version

$ npm run publish

This task will create a distribution version of the project inside your local dist/ folder and will publish on npm

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request :sunglasses:

Credits

TODO: Write credits

Built With

• VsCode
• npm
• Love :heart:

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Wassem Keddah - Initial work - wnabil
• Massimiliano Vinciprova - Makiwin

See also the list of contributors who participated in this project.

License

MIT License