GDI-Api-Node

Package for scaffolding a GDI API with NodeJS
· Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Acknowledgments

About The Project

Package for scaffolding a GDI API with NodeJS

(back to top)

Getting Started

Prerequisites

• nodejs
• Yarn

(back to top)

Installation

To install the package, create a .npmrc file in the same directory as your package.json.

@helsingborg-stad:registry=https://npm.pkg.github.com

Run locally

# install dependencies
yarn
# run tests
yarn test
# run tests and report coverage
yarn coverage

(back to top)

Usage

Examples can be found in the examples folder.

This package exposes a couple of sub-paths:

• gdi-api-node
• gdi-api-node/gql
• gdi-api-node/modules/healthcheck
• gdi-api-node/modules/jwt-user
• gdi-api-node/modules/swagger
• gdi-api-node/modules/web-framework

For more examples, please refer to the Documentation, made with yarn docs

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

• Best README Template

(back to top)