mirror of
https://github.com/featurebasedb/featurebase.git
synced 2026-09-05 08:10:50 +00:00
90 lines
3.7 KiB
Markdown
90 lines
3.7 KiB
Markdown
<p>
|
|
<a href="https://www.pilosa.com">
|
|
<img src="https://www.pilosa.com/img/logo.svg" width="50%">
|
|
</a>
|
|
</p>
|
|
|
|
[](https://circleci.com/gh/pilosa/pilosa/tree/master)
|
|
[](https://godoc.org/github.com/pilosa/pilosa)
|
|
[](https://goreportcard.com/report/github.com/pilosa/pilosa)
|
|
[](https://github.com/pilosa/pilosa/blob/master/LICENSE)
|
|
[](https://cla-assistant.io/pilosa/pilosa)
|
|
[](https://github.com/pilosa/pilosa/releases)
|
|
|
|
## An open source, distributed bitmap index.
|
|
- [Docs](#docs)
|
|
- [Getting Started](#getting-started)
|
|
- [Data Model](#data-model)
|
|
- [Query Language](#query-language)
|
|
- [Client Libraries](#client-libraries)
|
|
- [Get Support](#get-support)
|
|
- [Contributing](#contributing)
|
|
|
|
Want to contribute? One of the easiest ways is to [tell us how you're using (or want to use) Pilosa](https://github.com/pilosa/pilosa/issues/1074). We learn from every discussion!
|
|
|
|
## Docs
|
|
|
|
See our [Documentation](https://www.pilosa.com/docs/) for information about installing and working with Pilosa.
|
|
|
|
|
|
## Getting Started
|
|
|
|
1. [Install Pilosa](https://www.pilosa.com/docs/installation/).
|
|
|
|
Optionally, to include Lattice, the in-browser UI, follow the "Build from source" instructions, and run `make generate-statik` before `make install`. When you run a local Pilosa server on the default host, for example, you can access Lattice at [localhost:10101](http://localhost:10101).
|
|
|
|
2. [Start Pilosa](https://www.pilosa.com/docs/getting-started/#starting-pilosa) with the default configuration:
|
|
|
|
```shell
|
|
pilosa server
|
|
```
|
|
|
|
and verify that it's running:
|
|
|
|
```shell
|
|
curl localhost:10101/status
|
|
```
|
|
|
|
3. Follow along with the [Sample Project](https://www.pilosa.com/docs/getting-started/#sample-project) to get a better understanding of Pilosa's capabilities.
|
|
|
|
|
|
## Data Model
|
|
|
|
Check out how the Pilosa [Data Model](https://www.pilosa.com/docs/data-model/) works.
|
|
|
|
|
|
## Query Language
|
|
|
|
You can interact with Pilosa directly in the console using the [Pilosa Query Language](https://www.pilosa.com/docs/query-language/) (PQL).
|
|
|
|
|
|
## Upgrading UI
|
|
|
|
Lattice is now a submodule of Pilosa, for the purpose of keeping the frontend and backend components of the UI system synchronized. When making a change to the UI that requires changing both the backend and frontend, follow steps in this order:
|
|
|
|
1. merge frontend (Lattice) PR
|
|
2. run `make upgrade-lattice`
|
|
3. run `git add lattice`, `git commit -m"Upgrade Lattice"`, `git push`
|
|
4. merge backend (Pilosa) PR
|
|
|
|
## Client Libraries
|
|
|
|
There are supported libraries for the following languages:
|
|
- [Go](https://www.pilosa.com/docs/client-libraries/#go)
|
|
- [Java](https://www.pilosa.com/docs/client-libraries/#java)
|
|
- [Python](https://www.pilosa.com/docs/client-libraries/#python)
|
|
|
|
## License
|
|
|
|
Pilosa is licensed under the Apache License, Version 2.0.
|
|
|
|
A copy of the license is located in [github.com/pilosa/pilosa/LICENSE](https://github.com/pilosa/pilosa/blob/master/LICENSE).
|
|
More details about licensing are found in [github.com/pilosa/pilosa/NOTICE](https://github.com/pilosa/pilosa/blob/master/NOTICE).
|
|
|
|
## Get Support
|
|
|
|
There are [several channels](https://www.pilosa.com/community/#support) available for you to reach out to us for support.
|
|
|
|
## Contributing
|
|
|
|
Pilosa is an open source project. Please see our [Contributing Guide](CONTRIBUTING.md) for information about how to get involved.
|