Uconnect-Technologies / wertik-js

Wertik JS

💪 GraphQL + Rest API framework to kick start your project.

Table of contents

1. Install
2. Introduction
3. Folder Structure
4. Database
5. GraphQL
6. Rest API
7. Contributing
8. License

Install

Install with npm

npm install --save wertik-js

Install with yarn

yarn add wertik-js --dev

Please see Demo file for dev server configuration example.

Introduction

Wertik-js is a node js library to kick start your project using GraphQL and Rest API. You can use Weritk-js with running project, Wertik-js relies on Express and Apollo GraphQL. Wertik-js also comes with socket, logger, seeds and events feature.

Documentation

You can find Wertik documentation on Wapgee, Documentation Details:

• Main Page
• Installation
• Configuration
• Context
• Built in modules
• Custom modules
• How Wertik Works / Folder Structure
• How Wertik Works / GraphQL
• How Wertik Works / RestAPI

Folder Structure

It is good to know how Wertik-js works, Here is a guide to know how wertik works.

Database

Currrently Wertik-js is supporting databases which Sequelize supports. In future we will be adding Mongo DB Support.

GraphQL

Wertik-js GraphQL relies on Apollo GraphQL, Here GraphQL is loaded. Wertik-js allows you to write custom GraphQL modules(Queries and Mutations), Read More about custom modules in our documentation.

Rest API

Wertik-js RestAPI relies on only one which is Express. Here Rest API is initialized.Read More about custom modules to create custom API's for your modules.

Versioning

Wertik-js follows semantic versioning (semver) principles. The version can be look like this, X.Y.Z,

• Z When fixing bug we relase with chaning Z. For example: 1.2.1 to 1.2.2
• Y When adding feature we release with changing Y, For example: 1.2.1 to 1.3.1
• Z When adding breaking changes we made this release. For example: 1.2.1 to 2.2.1

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT