Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fortizpenaloza/cosmos

Internet of Things platform
https://github.com/fortizpenaloza/cosmos

internet-of-things iot pharo rest-api smalltalk

Last synced: 11 days ago
JSON representation

Internet of Things platform

Awesome Lists containing this project

README

        

# Cosmos

![Logo](assets/logos/128.png)

With Cosmos, I aim to provide a platform to collect data from connected devices
and act on them defining a set of rules.

> *Name origin*: [Cosmos](https://en.wikipedia.org/wiki/Cosmos) is used at times
when the universe is regarded as a complex and orderly system or entity;
the opposite of chaos.

[![Pharo - Unit Tests](https://github.com/fortizpenaloza/Cosmos/actions/workflows/unit-tests.yml/badge.svg?branch=release-candidate)](https://github.com/fortizpenaloza/Cosmos/actions/workflows/unit-tests.yml)
[![Coverage Status](https://codecov.io/github/fortizpenaloza/Cosmos/coverage.svg?branch=release-candidate)](https://codecov.io/gh/fortizpenaloza/Cosmos/branch/release-candidate)
[![Baseline Groups](https://github.com/fortizpenaloza/Cosmos/actions/workflows/loading-groups.yml/badge.svg)](https://github.com/fortizpenaloza/Cosmos/actions/workflows/loading-groups.yml)
[![Markdown Lint](https://github.com/fortizpenaloza/Cosmos/actions/workflows/markdown-lint.yml/badge.svg)](https://github.com/fortizpenaloza/Cosmos/actions/workflows/markdown-lint.yml)
[![Pharo 10](https://img.shields.io/badge/Pharo-10-informational)](https://pharo.org)
[![Pharo 11](https://img.shields.io/badge/Pharo-11-informational)](https://pharo.org)

Quick links

- [**Explore the docs**](/docs)
- [Report a defect](https://github.com/fortizpenaloza/cosmos/issues/new?labels=Type%3A+Bug)
- [Request feature](https://github.com/fortizpenaloza/cosmos/issues/new?labels=Type%3A+Development)

## License

- The code is licensed under [MIT](LICENSE).
- The documentation is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/).

## Quick Start

### Using a docker image

A Docker image is pushed to [Docker Hub](https://hub.docker.com) every time
CI runs successfully.

In order to use it you must pull the latest docker image by typing into
your CLI
`docker pull fortizpenaloza/cosmos`

and then start it typing
`docker run -v logs:/opt/cosmos/logs --rm -p 8090:8090 fortizpenaloza/cosmos`

### Using an Pharo image

- Download the latest [Pharo 32](https://get.pharo.org/) or [64 bits VM](https://get.pharo.org/64/).
- Download a ready to use image from the [release page](http://github.com/iot-uca/back-end/releases/latest)
- Explore the [documentation](docs/).

## Installation

To load the project in a Pharo image, or declare it as a dependency of your own
project follow this [instructions](docs/Installation.md)

## Contributing

Check the [Contribution Guidelines](CONTRIBUTING.md)