raystack/cosmos

Cosmos is an operational analytics server to build custom apps with embedded analytics that deliver data experiences as unique as your business.

Cosmos

Getting Started

Cosmos Docker image can be found here

docker run -e MONGODB_HOST=mongodb://127.0.0.1:27017/cosmos -p 8000:8000 docker.pkg.github.com/odpf/cosmos/cosmos

Visit http://localhost:8000/documentation to view API documentation.

Environment Variables

PORT (optional, default: 8000)
MONGODB_HOST (required)
ENCRYPTION_SECRET_KEY (default: "")
CUBE_URL (default: "http://localhost:4000" )

Building from source

Prerequisite Tools

• Node.js (version >= 12.0.0)
• MongoDB
• Git

1. Clone the repo

   $ git clone https://github.com/odpf/cosmos
   $ cd cosmos

2. Install dependencies

   $ npm install

3. Run development server

   $ npm run dev

4. Build production server

   $ npm build

5. Run production server locally

   $ npm start

Running tests

All of the tests are written with jest. They can be run with npm/yarn.

$ npm test

Versioning

We use SemVer for versioning. For the versions available, see the tags.

License

Cosmos is released under the Apache License 2.0. See LICENSE