https://github.com/raystack/cosmos

Cosmos is an operational analytics server to build custom apps with embedded analytics that deliver data experiences as unique as your business.
https://github.com/raystack/cosmos

analysis cubejs dataops framework metrics

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/raystack/cosmos
• Owner: raystack
• License: apache-2.0
• Created: 2021-02-16T06:26:01.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-01T03:26:49.000Z (over 2 years ago)
• Last Synced: 2024-07-30T17:59:39.190Z (6 months ago)
• Topics: analysis, cubejs, dataops, framework, metrics
• Language: TypeScript
• Homepage:
• Size: 3.89 MB
• Stars: 46
• Watchers: 10
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cosmos

[![node-ci](https://github.com/odpf/cosmos/actions/workflows/test.yml/badge.svg)](https://github.com/odpf/cosmos/actions/workflows/test.yml)

[![codecov](https://codecov.io/gh/odpf/cosmos/branch/main/graph/badge.svg?token=2CkqMa9YmH)](https://codecov.io/gh/odpf/cosmos)

## Getting Started

Cosmos Docker image can be found [here](https://github.com/orgs/odpf/packages?repo_name=cosmos)

```sh

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](http://localhost:8000/documentation) to view API documentation.

## Environment Variables

```bash

PORT (optional, default: 8000)

MONGODB_HOST (required)

ENCRYPTION_SECRET_KEY (default: "")

CUBE_URL (default: "http://localhost:4000" )

```

## Building from source

### Prerequisite Tools

- [Node.js](https://nodejs.org/) (version >= 12.0.0)

- [MongoDB](https://www.mongodb.com/)

- [Git](https://git-scm.com/)

1. Clone the repo

   ```sh

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

   $ cd cosmos

   ```

2. Install dependencies

   ```sh

   $ npm install

   ```

3. Run development server

   ```sh

   $ npm run dev

   ```

4. Build production server

   ```sh

   $ npm build

   ```

5. Run production server locally

   ```sh

   $ npm start

   ```

## Running tests

All of the tests are written with [jest](https://jestjs.io/). They can be run with npm/yarn.

```sh

$ npm test

```

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags](https://github.com/odpf/cosmos/tags).

## License

Cosmos is released under the Apache License 2.0. See [LICENSE](LICENSE)