Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teodevgroup/teo
Schema-driven web server framework.
https://github.com/teodevgroup/teo
agile agile-development apiserver apiservice code-generation database http http-server language-parser nodejs orm python rust server single-file webdevelopment webframework
Last synced: about 2 months ago
JSON representation
Schema-driven web server framework.
- Host: GitHub
- URL: https://github.com/teodevgroup/teo
- Owner: teodevgroup
- License: apache-2.0
- Created: 2022-05-18T10:25:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-28T05:51:25.000Z (about 2 months ago)
- Last Synced: 2024-07-28T06:44:41.790Z (about 2 months ago)
- Topics: agile, agile-development, apiserver, apiservice, code-generation, database, http, http-server, language-parser, nodejs, orm, python, rust, server, single-file, webdevelopment, webframework
- Language: Rust
- Homepage: https://teodev.io
- Size: 3.53 MB
- Stars: 1,334
- Watchers: 14
- Forks: 43
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
## Introduction
Teo is **schema-driven** web server framework. The server side API is native to Rust, Node.js and Python.
## Highlights & Features
* Native to **Rust**, **Node.js** and **Python**
* Innovative schema definition inspired by **GraphQL** and **Prisma**
* Auto database migration
* Supports **MySQL**, **PostgreSQL**, **SQLite** and **MongoDB**
* Generated **ORM** types and interfaces
* Generated **query clients** for frontend
* Very efficient and performant
* Data sanitization, transformation and validation
* Builtin user **sessions**
* Builtin **permission** check
* First in last out **middlewares**
* Custom **route handlers**
* Generated customizable **admin dashboard**
* Plays great with AI tools
## Getting started
The fastest way to get started with Teo is by following the [Quickstart guide](https://docs.teodev.io/getting-started/quickstart).
### Installation
Install Node.js edition.
```sh
npm install @teocloud/teo
```
Install Python edition.
```sh
pip install teo
```
Install Rust edition.
```sh
cargo install teo
```
### Write a schema-only server
To write a server is quite simple with Teo. Create a file named `schema.teo`.
Specify which database to connect and which port to listen.
```teo
connector {
provider: .sqlite,
url: "sqlite::memory:"
}
server {
bind: ("0.0.0.0", 5050)
}
model User {
@id @autoIncrement @readonly
id: Int
@unique @onSet($if($presents, $isEmail))
email: String
name: String?
@relation(fields: .id, references: .authorId)
posts: Post[]
}
model Post {
@id @autoIncrement @readonly
id: Int
title: String
content: String?
@default(false)
published: Bool
@foreignKey
authorId: Int
@relation(fields: .authorId, references: .id)
author: User
}
```
Start the server with `teo serve` command. Now you can create, update, delete,
read, aggregate and group by. Read our
[Query client guide](https://docs.teodev.io/guides/query-client-guides/crud)
for detailed usage.
### Write custom handlers
Declare the handler in the schema.
```teo
@map(.get, "/echo/:data", interface: "EchoPathArguments")
declare nonapi handler echo(): Any
```
Implement the handler with program code.
#### Node.js implementation
```ts
import { App, Response, RequestCtx } from '@teocloud/teo'
import { EchoPathArguments } from './entities'
const app = new App()
app.mainNamespace().defineHandler("echo", (ctx: RequestCtx) => {
const pathArguments: EchoPathArguments = ctx.pathArguments()
return Response.string(pathArguments.data, "text/plain")
})
app.run()
```
#### Python implementation
```python
from asyncio import run
from teo import App, Response, RequestCtx
from entities import EchoPathArguments
async def main():
app = App()
def echo_handler(ctx: RequestCtx):
path_arguments: EchoPathArguments = ctx.path_arguments()
return Response.string(path_arguments["data"], "text/plain")
app.main_namespace().define_handler("echo", echo_handler)
await app.run()
run(main())
```
#### Rust implementation
```rust
mod entities;
use tokio::main;
use teo::prelude::{App, Response, Result, path};
use crate::entities::EchoPathArguments;
#[main]
async fn main() -> Result<()> {
let app = App::new()?;
app.main_namespace().define_handler("echo", |path_args: EchoPathArguments| async move {
Ok::(Response::string(path_args.data(), "text/plain"))
});
app.run().await
}
```
## Tutorials
We prepared a [Beginner tutorial series](https://docs.teodev.io/getting-started/beginner-tutorial/write-a-schema-only-app)
to help you learn and understand Teo.
## Issues
Welcome to submit issues in this repo.
## Contributing
Read our [Contributing guide](https://github.com/teodevgroup/teo/blob/main/CONTRIBUTING.md)
to set projects up and start contributing.
## License
TEO is under Apache 2.0 license.
