README
¶
For developers who want to build scalable web and mobile apps fast!
With a zero-ops scalable pub/sub messaging system and fault-tolerant
cloud-native database,
Tigris provides everything you need to get up and
running quickly and efficiently.
Website | Quickstart | API Reference | Slack Community | Twitter
Helpful Links
- Key Concepts
- Quickstarts
- Data Modeling
- Guides
- Client Library: Go
- Client Library: Java
- Command Line Interface
Community & Support
Developing
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.
Running tests in docker containers
Tests are executed using make test. This runs both unit and integration
tests. The FoundationDB container auto-generates the cluster file which is
shared between containers using a docker volume.
The docker volume fdbdata is mounted at:
- /var/fdb/fdb.cluster in tigris_fdb container
- /etc/foundationdb/fdb.cluster in tigris_test and tigris_server containers, which is the default location where the client will search for the cluster file
Building and Testing on Apple M1
Due to various issues with Docker on Apple M1, it is recommended to install FoundationDB on the host and run the server on the host directly as well.
To run the server on the host, required dependencies need to be installed by running:
sh scripts/install_build_deps.sh
sh scripts/install_test_deps.sh
Once the dependencies are installed, you can start up the server on the host as follows:
make osx_run
You can run the test on your local machine as follows:
make osx_test
License
This software is licensed under the Apache 2.0.
Directories