Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zzy/actix-web-async-graphql-rbatis
Clean boilerplate for graphql services using actix-web, rhai, async-graphql, surf, rbatis, graphql-client, handlebars-rust, jsonwebtoken, and mysql / postgresql.
https://github.com/zzy/actix-web-async-graphql-rbatis
actix-web async-graphql embbeded-scripting-rust graphql-client graphql-server handlebars jsonwebtoken jwt-authentication mysql postgresql rbatis rhai rust surf
Last synced: about 2 hours ago
JSON representation
Clean boilerplate for graphql services using actix-web, rhai, async-graphql, surf, rbatis, graphql-client, handlebars-rust, jsonwebtoken, and mysql / postgresql.
- Host: GitHub
- URL: https://github.com/zzy/actix-web-async-graphql-rbatis
- Owner: zzy
- License: apache-2.0
- Created: 2021-04-13T04:33:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-07T01:22:31.000Z (over 2 years ago)
- Last Synced: 2023-03-22T23:33:15.164Z (over 1 year ago)
- Topics: actix-web, async-graphql, embbeded-scripting-rust, graphql-client, graphql-server, handlebars, jsonwebtoken, jwt-authentication, mysql, postgresql, rbatis, rhai, rust, surf
- Language: Rust
- Homepage: https://blog.budshome.com/topics/graphql
- Size: 111 KB
- Stars: 26
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# actix-web-async-graphql-rbatis
Clean boilerplate for graphql services using actix-web, rhai, async-graphql, surf, rbatis, graphql-client, handlebars-rust, jsonwebtoken, and mysql / postgresql.
See also: [tide-async-graphql-mongodb](https://github.com/zzy/tide-async-graphql-mongodb)
## Features
- Graphql Services
- [x] User register
- [x] Salt and hash a password with PBKDF2 - 使用 PBKDF2 对密码进行加密（salt）和散列（hash）运算
- [x] Sign in
- [x] JSON web token authentication - JWT 鉴权整合
- [x] Change password
- [x] Profile Update
- [x] User: query & mutation
- [x] Project: query & mutation
- Web Application
- [x] Client request, bring & parse GraphQL data
- [x] Render data to template engine
- [x] Define custom helper with Rhai scripting language
## Stacks
- [Rust](https://www.rust-lang.org) - [中文资料集萃](https://budshome.com)
- [actix-web](https://crates.io/crates/actix-web) - [中文文档](https://actix-web.budshome.com)
- [rhai](https://crates.io/crates/rhai) - Embedded Scripting for Rust
- [async-graphql](https://crates.io/crates/async-graphql) - [中文文档](https://async-graphql.budshome.com)
- [rbatis](https://crates.io/crates/rbatis)
- [Surf](https://crates.io/crates/surf)
- [graphql_client](https://crates.io/crates/graphql_client)
- [handlebars-rust](https://crates.io/crates/handlebars)
- [jsonwebtoken](https://crates.io/crates/jsonwebtoken)
- [cookie-rs](https://crates.io/crates/cookie)
## How to run?
``` Bash
git clone https://github.com/zzy/actix-web-async-graphql.git
cd actix-web-async-graphql
cargo build
```
### Frontend - actix-web server
``` Bash
cd frontend-handlebars
```
Rename file `.env.example` to `.env`, or put the environment variables into a `.env` file:
```
ADDRESS=127.0.0.1
PORT=3000
GRAPHQL_PORT=8080
GRAPHQL_PATH=graphql
GRAPHIQL_PATH=graphiql
```
Build & Run:
``` Bash
cargo run
```
Then connect to http://127.0.0.1:3000 with browser.
### Backend - Graphql Server
``` Bash
cd backend
```
Rename file `.env.example` to `.env`, or put the environment variables into a `.env` file:
```
ADDRESS=127.0.0.1
PORT=8080
GRAPHQL_PATH=graphql
GRAPHIQL_PATH=graphiql
MYSQL_URI=mysql://root:mysql@localhost:3306/budshome
POSTGRES_URI=postgres://root:mysql@localhost:5432/budshome
SITE_KEY=0F4EHz+1/hqVvZjuB8EcooQs1K6QKBvLUxqTHt4tpxE=
CLAIM_EXP=10000000000
```
Build & Run:
``` Bash
cargo run
```
GraphiQL: connect to http://127.0.0.1:8080/graphiql with browser.
## Queries
- getUserByEmail(...): User!
- getUserByUsername(...): User!
- userSignIn(...): SignInfo!
- allUsers(...): [User!]!
- allProjects: [Project!]!
- allProjectsByUser(...): [Project!]!
## MUTATIONS
- userRegister(...): User!
- userChangePassword(...): User!
- userUpdateProfile(...): User!
- addProject(...): Project!
## Sample Usage
Sample mutation for user register:
```
mutation {
userRegister(
newUser: {
email: "[email protected]",
username: "我是谁",
password: "wo#$shi^$shui"
}
) {
id
email
username
}
}
```
Sample query for user sign in:
```
{
userSignIn(
userAccount: {
email: "[email protected]"
username: ""
password: "wo#$shi^$shui"
}
) {
email
username
token
}
}
```
When submit method `userSignIn`, a token would be generated, use this token for query all users and every user's projects:
```
{
allUsers(
token: "fyJ0eXAiOiJKV1Q..."
) {
id
email
username
projects {
id
userId
subject
website
}
}
}
```
Sample query and mutation for projects was similar to users.
## Contributing
You are welcome in contributing to this project.