README
¶
Tigris is an open source developer data platform that provides an integrated suite of database and data services, enabling you to build rich applications that perform consistently at any scale.
Website | Quickstart | API Reference | Discord | Twitter
Helpful Links
- Quickstart
- Architecture
- Databases and Collections
- Documents
- Search
- Observability
- TypeScript Reference
- Go Reference
- Java Reference
- CLI
- Guides
Community & Support
Developing
Setup local development environment
To setup your local development environment. Make sure you have Go installed or run:
sh scripts/install_go.sh
Add your $GOPATH to your $PATHS environment variable. And then to download and
install the build dependencies and FoundationDB run:
sh scripts/install_build_deps.sh
Building with Docker Containers
Start local Tigris server listening on http://localhost:8081 by running:
make run
This would bring dependencies and server up in the docker containers with all your changes.
Alternatively, you can run make run_full to bring up monitoring tools as well.
- Graphana: http://localhost:3000
- Prometheus: http://localhost:9090
Running tests
Run in the docker container
Tests are executed using make test. This runs both unit and integration
tests in the docker containers.
Run in the IDE
Run make run to bring the server up in the docker container.
Now you can run individual tests in the IDE of your choice.
Entire test suite can be run using make local_test.
Debugging the server in the IDE
Run make local_run to start Tigris server on the host.
Now you can attach to the process and debug from the IDE.
License
This software is licensed under the Apache 2.0.
Directories