37 lines
2 KiB
Markdown
37 lines
2 KiB
Markdown
# Stasis
|
||
[](https://travis-ci.org/stasis_io/stasis)
|
||
[](https://ci.appveyor.com/project/stasis/stasis/branch/master)
|
||
[](https://gitter.im/stasis/stasis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
[](https://index.scala-lang.org/stasis/stasis/stasis-core)
|
||
|
||
### [User documentation][docs]
|
||
Head over to [the user docs][docs] for instructions on how to install stasis.
|
||
|
||
### Quick help
|
||
|
||
- To build: `sbt compile`
|
||
- Run all unit tests: `sbt test`
|
||
- Build docs: See instructions on the [site][docs-guide] or locally at `./docs/contributing-website.md`.
|
||
- Run benchmarks: `./bin/run-benchmarks.sh`.
|
||
- Run formatter on millions of lines of code: `tests/test:runMain io.stasis.StasisProps` (slow, and requires a lot of memory/cpu)
|
||
- Debug performance: after each test run in `FormatTests`, a flamegraph report
|
||
like [this one](https://github.com/stasis/stasis/issues/140) is generated in `target/index.html`.
|
||
I usually keep a browser tab open at `localhost:3000/target/index.html` along with this background process:
|
||
`browser-sync start --server --files "target/*.html"`.
|
||
See [Browsersync](https://www.browsersync.io/).
|
||
|
||
### Team
|
||
The current maintainers (people who can merge pull requests) are:
|
||
|
||
* Gregory Burd - [`@gburd`](https://github.com/gburd)
|
||
|
||
An up-to-date list of contributors is available here: https://github.com/stasis/stasis/graphs/contributors but this
|
||
doesn't include the developers from Sleepycat and Oracle who maintained Berkeley DB Java Edition before it development
|
||
was halted in 2017. In 2019 the Stasis project started as a fork of JE.
|
||
|
||
We strive to offer a welcoming environment to learn, teach and contribute.
|
||
|
||
## Acknowledgments
|
||
|
||
[docs]: https://stasis.io/docs/
|
||
|