wabe 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +70 -0
- package/bunfig.toml +4 -0
- package/dist/generated/wabe.d.ts +1287 -0
- package/dist/index.d.ts +921 -0
- package/dist/index.js +108814 -0
- package/generated/schema.graphql +1236 -0
- package/generated/wabe.ts +1518 -0
- package/package.json +53 -0
package/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://wabe.dev"><img src="https://www.wabe.dev/logo.png" alt="Wabe logo" height=170></a>
|
|
3
|
+
</p>
|
|
4
|
+
<h1 align="center">Wabe</h1>
|
|
5
|
+
|
|
6
|
+
<div align="center">
|
|
7
|
+
<a href="https://wabe.dev">Documentation</a>
|
|
8
|
+
</div>
|
|
9
|
+
|
|
10
|
+
## What is Wabe?
|
|
11
|
+
|
|
12
|
+
Wabe is an open-source backend that allows you to create your own fully customizable backend in just a few minutes. It handles database access, automatic GraphQL API generation, authentication with various methods (classic or OAuth), permissions, security, and more for you.
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
```sh
|
|
17
|
+
bun install wabe # On bun
|
|
18
|
+
npm install wabe # On npm
|
|
19
|
+
yarn add wabe # On yarn
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Basic example
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
import { DatabaseEnum, Wabe } from "wabe";
|
|
26
|
+
|
|
27
|
+
const run = async () => {
|
|
28
|
+
// Insure your database is running before run the file
|
|
29
|
+
|
|
30
|
+
const wabe = new Wabe({
|
|
31
|
+
// Root key example (must be long minimal 64 characters, you can generate it online)
|
|
32
|
+
rootKey:
|
|
33
|
+
"0uwFvUxM$ceFuF1aEtTtZMa7DUN2NZudqgY5ve5W*QCyb58cwMj9JeoaV@d#%29v&aJzswuudVU1%nAT+rxS0Bh&OkgBYc0PH18*",
|
|
34
|
+
database: {
|
|
35
|
+
type: DatabaseEnum.Mongo,
|
|
36
|
+
url: "mongodb://127.0.0.1:27045",
|
|
37
|
+
name: "WabeApp",
|
|
38
|
+
},
|
|
39
|
+
port: 3000,
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
await wabe.start();
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
await run();
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Features
|
|
49
|
+
|
|
50
|
+
- **Authentication**: Secure and scalable authentication for your applications.
|
|
51
|
+
- **Permissions**: Granular permissions control to secure your resources.
|
|
52
|
+
- **Database**: A powerful, scalable database to store and manage you data.
|
|
53
|
+
- **GraphQL API**: A flexible and powerful GraphQL API (following GraphQL Relay standard) to interact with your data.
|
|
54
|
+
- **Hooks**: Powerful hooks system to execute custom actions before or after database requests.
|
|
55
|
+
|
|
56
|
+
## Contributing
|
|
57
|
+
|
|
58
|
+
Contributions are always welcome! If you have an idea for something that should be added, modified, or removed, please don't hesitate to create a pull request (I promise a quick review).
|
|
59
|
+
|
|
60
|
+
You can also create an issue to propose your ideas or report a bug.
|
|
61
|
+
|
|
62
|
+
Of course, you can also use Wabe for your backend; that is the better contribution at this day ❤️.
|
|
63
|
+
|
|
64
|
+
If you like the project don't forget to share it.
|
|
65
|
+
|
|
66
|
+
More informations on the [Contribution guide](https://github.com/palixir/wabe/blob/main/CONTRIBUTING.md)
|
|
67
|
+
|
|
68
|
+
## License
|
|
69
|
+
|
|
70
|
+
Distributed under the Apache License 2.0 [License](https://github.com/palixir/wabe/blob/main/LICENSE).
|
package/bunfig.toml
ADDED