Giter VIP home page Giter VIP logo

wertik-js's Introduction

Wertik-JS V3

Wertik is a tiny Node JS framework that helps you set up servers with support for

  • MySQL Database
  • Emailing
  • GraphQL
  • Modules
  • Rest Api
  • Storage
  • Sockets
  • Cron Jobs
  • Redis
  • Logger

Installation

You can install wertik-js by using yarn or npm:

Yarn

yarn add wertik-js

Npm

npm install wertik-js

Setting up server

To start wertik-js server you need to import wertik and start it:

import wertik from "wertik-js/lib/"

weritk({
  port: 1200,
})

In your console you will see something like this:

Wertik JS app listening at http://localhost:1200

If you visit http://localhost:1200, you will see a response like this:

Cannot GET /

๐Ÿš€ You have successfully started wertik server. There is nothing in wertik app right now. Let's make it interactive by adding:

  • MySQL Database
  • Mailer
  • GraphQL
  • Modules
  • Rest Api
  • Storage
  • Sockets
  • Cron Jobs
  • Redis

Accessing Wertik Inside GraphQL Resolver and Express Handler

You can access Wertik instance inside GraphQL and Express handler through:

  • Express
app.get("/somepath", (req, res) => {
  console.log(req.wertik) // Wertik App
  res.send("Some Info")
})

For more please see This line.

  • GraphQL Resolver
function Resolver(_, args, context, info) => {
  console.log(context.wertik); // Wertik App
  return "Some Info"
}

For more please see: This line

With keyword Wertik you can access everything that lies inside wertik from database, modules, sockets, mailer, cron jobs to everything in Wertik app.

Why you should use Wertik JS

Wertik JS lightens up your app with different features, Wertik can be helpful for small projects such as task management or a blog application. With modules with Wertik JS, you can easily create modules with crud operations. Furthermore, Wertik JS can lighten up your app with useful features such as Redis, Sockets, Database such as Mysql, Queue Management, Storage, Cron Jobs, and other useful features.

How Wertik JS works internally

Wertik JS v3 is setup in a clean way and easy way. Here is the main file which initializes Wertik JS: Show File.

You can check the code and if you find something that needs to be changed, you can create a new Issue here.

Did you find a grammatical mistake in the documentation?

If you came across a grammatical mistake please create a new issue with more details in the description: here.

Contribute & Support

Pull requests are welcome. If you have discovered a bug or have a feature suggestion, feel free to create an issue on GitHub.

If you'd like to make some changes yourself, see the following:

  • Fork this repository to your own GitHub account and then clone it to your local device
  • Make sure yarn is globally installed (npm install -g yarn)
  • Run yarn to download required packages.
  • Build and start the application: yarn dev-next
  • If you contributed something new, run yarn contrib:add to add yourself to the contributors list
  • Finally, submit a pull request with your changes!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.