https://github.com/vitaliy-art/tarantoolscript-server-example
Simple TarantoolScript server implementation
https://github.com/vitaliy-art/tarantoolscript-server-example
database example http-server lua tarantool tarantoolscript typescript typescript-to-lua
Last synced: 6 months ago
JSON representation
Simple TarantoolScript server implementation
- Host: GitHub
- URL: https://github.com/vitaliy-art/tarantoolscript-server-example
- Owner: vitaliy-art
- License: mit
- Created: 2024-03-06T19:43:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-17T02:01:31.000Z (about 1 year ago)
- Last Synced: 2024-11-17T03:16:22.894Z (about 1 year ago)
- Topics: database, example, http-server, lua, tarantool, tarantoolscript, typescript, typescript-to-lua
- Language: TypeScript
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# TarantoolScript server example
This project is a simple example of [Tarantool](https://www.tarantool.io/en/) HTTP-server, written on TypesScript with [TypescriptToLua](https://typescripttolua.github.io/) and [TarantoolScript](https://github.com/vitaliy-art/tarantoolscript). It is intended to demonstrate the possibility of writing Tarantool Lua scripts with TypeScript.
## Build
To build this project, you need to install first [Node.js](https://nodejs.org/). After installation just run in console:
```bash
npm run build
```
Or just use make:
```bash
make build
```
## Run
After successfully building all Lua files will be placed into `./build/app` directory. You can use this files to run them with [tt CLI utility](https://www.tarantool.io/en/doc/latest/reference/tooling/tt_cli/) or with Tarantool directly.
### Lua dependencies
Before launch Lua script, make sure you have installed [http](https://github.com/tarantool/http) package.
## Tests
For run tests, you need to install first [luatest](https://github.com/tarantool/luatest) and optionally `luacov`. To launch tests run in console:
```bash
npm run test
```
or
```bash
npm run test-coverage
```
## Devcontainer
This project includes [VSCode DevContainer](https://code.visualstudio.com/docs/devcontainers/tutorial) configurations, so you can just open it in development container which includes all needed dependencies.