Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uconnect-technologies/wertik-js
💪 A library that powers your app with GraphQL + Rest API
https://github.com/uconnect-technologies/wertik-js
api boilerplate database express-graphql express-graphql-boilerplate express-js graphql graphql-server javascript mongodb-database mongoose mysql nodejs reactjs saas-boilerplate starter-kit vuejs wertik-js
Last synced: 30 days ago
JSON representation
💪 A library that powers your app with GraphQL + Rest API
- Host: GitHub
- URL: https://github.com/uconnect-technologies/wertik-js
- Owner: Uconnect-Technologies
- License: mit
- Created: 2018-12-30T22:34:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T10:01:59.000Z (7 months ago)
- Last Synced: 2024-04-13T21:13:29.218Z (7 months ago)
- Topics: api, boilerplate, database, express-graphql, express-graphql-boilerplate, express-js, graphql, graphql-server, javascript, mongodb-database, mongoose, mysql, nodejs, reactjs, saas-boilerplate, starter-kit, vuejs, wertik-js
- Language: TypeScript
- Homepage: http://wapgee.com/wertik
- Size: 3.63 MB
- Stars: 87
- Watchers: 10
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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:
```js
import wertik from "wertik-js/lib/"
weritk({
port: 1200,
})
```
In your console you will see something like this:
```log
Wertik JS app listening at http://localhost:1200
```
If you visit [http://localhost:1200](http://localhost:1200), you will see a response like this:
```log
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
```javascript
app.get("/somepath", (req, res) => {
console.log(req.wertik) // Wertik App
res.send("Some Info")
})
```
For more please see [This line](https://github.com/Uconnect-Technologies/wertik-js/blob/master/src/next/index.ts#:~:text=req.wertik%20%3D%20wertikApp%3B).
- GraphQL Resolver
```javascript
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](https://github.com/Uconnect-Technologies/wertik-js/blob/master/src/next/index.ts).
You can check the code and if you find something that needs to be changed, you can create a new Issue [here](https://github.com/Uconnect-Technologies/wertik-js/issues/new).
## 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](https://github.com/Uconnect-Technologies/wertik-js/issues/new?title=I%20found%20a%20grammatical%20mistake).
## 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!