Skip to content

Commit f3e6383

Browse files
committed
update readme
1 parent 9b59d15 commit f3e6383

File tree

1 file changed

+98
-5
lines changed

1 file changed

+98
-5
lines changed

README.md

Lines changed: 98 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,37 @@
1-
# Kuzzle Application
1+
<p align="center">
2+
<img src="https://user-images.githubusercontent.com/7868838/103797784-32337580-5049-11eb-8917-3fcf4487644c.png"/>
3+
</p>
4+
<p align="center">
5+
<img alt="GitHub branch checks state" src="https://img.shields.io/github/checks-status/kuzzleio/template-kuzzle-project/master">
6+
<a href="https://github.com/kuzzleio/kuzzle/blob/master/LICENSE">
7+
<img alt="undefined" src="https://img.shields.io/github/license/kuzzleio/kuzzle.svg?style=flat">
8+
</a>
9+
</p>
210

3-
_An application running with [Kuzzle](https://github.com/kuzzleio/kuzzle)_
11+
## Why Kuzzle ?
12+
13+
Kuzzle is a [generic backend](https://docs.kuzzle.io/core/2/guides/introduction/general-purpose-backend/) offering **the basic building blocks common to every application**.
14+
15+
Rather than developing the same standard features over and over again each time you create a new application, Kuzzle proposes them off the shelf, allowing you to focus on building **high-level, high-value business functionalities**.
16+
17+
Kuzzle enables you to build modern web applications and complex IoT networks in no time.
18+
19+
* **API First**: use a standardised multi-protocol API.
20+
* **Persisted Data**: store your data and perform advanced searches on it.
21+
* **Realtime Notifications**: use the pub/sub system or subscribe to database notifications.
22+
* **User Management**: login, logout and security rules are no more a burden.
23+
* **Extensible**: develop advanced business feature directly with the integrated framework.
24+
* **Client SDKs**: use our SDKs to accelerate the frontend development.
25+
26+
Learn how Kuzzle will accelerate your developments :point_right: https://docs.kuzzle.io/core/2/guides/introduction/what-is-kuzzle/
27+
28+
## Kuzzle in production
29+
30+
Kuzzle is production-proof, and can be [deployed anywhere](https://kuzzle.io/products/by-features/on-premises/).
31+
32+
With Kuzzle, it is possible to deploy applications that can serve tens of thousands of users with very good performances.
33+
34+
Check out our [support plans](https://kuzzle.io/pricing/).
435

536
## Installation and run
637

@@ -10,10 +41,72 @@ Requirement:
1041
- Docker
1142
- Docker-Compose
1243

13-
First, install [Kourou](https://github.com/kuzzleio/kourou), the Kuzzle CLI: `npm install -g kourou`
14-
1544
# Usage
1645

1746
```bash
1847
docker compose up -d
19-
```
48+
```
49+
50+
## Use the framework
51+
52+
Your first Kuzzle application is inside the `app.ts` file.
53+
54+
For example, you can add a new [API Controller](https://docs.kuzzle.io/core/2/guides/develop-on-kuzzle/api-controllers):
55+
56+
```ts
57+
import { Backend } from 'kuzzle';
58+
59+
const app = new Backend('playground');
60+
61+
app.controller.register('greeting', {
62+
actions: {
63+
sayHello: {
64+
handler: async request => `Hello, ${request.input.args.name}`
65+
}
66+
}
67+
});
68+
69+
app.start()
70+
.then(() => {
71+
app.log.info('Application started');
72+
})
73+
.catch(console.error);
74+
```
75+
76+
Now try to call your new API action by:
77+
- opening the generated URL in your browser: http://localhost:7512/_/greeting/say-hello?name=Yagmur
78+
- using Kourou: `npx kourou greeting:sayHello --arg name=Yagmur`
79+
80+
Learn how to [Write an Application](https://docs.kuzzle.io/core/2/guides/getting-started/write-application/).
81+
82+
### Useful links
83+
84+
* [Getting Started with Kuzzle](https://docs.kuzzle.io/core/2/guides/getting-started/run-kuzzle/)
85+
* [API](https://docs.kuzzle.io/core/2/guides/main-concepts/api/)
86+
* [Data Storage](https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/)
87+
* [Querying](https://docs.kuzzle.io/core/2/guides/main-concepts/querying/)
88+
* [Permissions](https://docs.kuzzle.io/core/2/guides/main-concepts/permissions/)
89+
* [Authentication](https://docs.kuzzle.io/core/2/guides/main-concepts/authentication/)
90+
* [Realtime Engine](https://docs.kuzzle.io/core/2/guides/main-concepts/realtime-engine/)
91+
* [Discover our SDKs](https://docs.kuzzle.io/sdk/v2.html)
92+
* [Release Notes](https://github.com/kuzzleio/kuzzle/releases)
93+
94+
## Get trained by the creators of Kuzzle :zap:
95+
96+
Train yourself and your teams to use Kuzzle to maximize its potential and accelerate the development of your projects.
97+
Our teams will be able to meet your needs in terms of expertise and multi-technology support for IoT, mobile/web, backend/frontend, devops.
98+
:point_right: [Get a quote](https://kuzzle.io/pricing/)
99+
100+
101+
## Join our community
102+
103+
* Follow us on [twitter](https://twitter.com/kuzzleio) to get latest news
104+
* Register to our monthly [newsletter](http://eepurl.com/bxRxpr) to get highlighed news
105+
* Visit our [blog](https://blog.kuzzle.io/) to be informed about what we are doing
106+
* Come chat with us on [Discord](http://join.discord.kuzzle.io)
107+
* Ask technical questions on [stack overflow](https://stackoverflow.com/search?q=kuzzle)
108+
109+
## License
110+
111+
Kuzzle is published under [Apache 2 License](./LICENSE.md).
112+

0 commit comments

Comments
 (0)