README.md 1.61 KB
Newer Older
Eduardo L. Buratti's avatar
Eduardo L. Buratti committed
1
# [![BlenDB Logo](https://gitlab.c3sl.ufpr.br/c3sl/blendb/raw/master/artwork/logo-wide.png)](https://gitlab.c3sl.ufpr.br/c3sl/blendb)
2
[![Build Status](https://gitlab.c3sl.ufpr.br/c3sl/blendb/badges/master/build.svg)](https://gitlab.c3sl.ufpr.br/c3sl/blendb/commits/master)
Eduardo L. Buratti's avatar
Eduardo L. Buratti committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
[![Coverage Report](https://gitlab.c3sl.ufpr.br/c3sl/blendb/badges/master/coverage.svg)](https://gitlab.c3sl.ufpr.br/c3sl/blendb/builds)

<p align="center">
<b><a href="#getting-started">Getting Started</a></b>
|
<b><a href="#api-reference">API Reference</a></b>
|
<b><a href="#contributing">Contributing</a></b>
|
<b><a href="#license">License</a></b>
|
<b><a href="#built-with">Built With</a></b>
</p>

<br/>

## Getting Started

### Installing

```
git clone https://gitlab.c3sl.ufpr.br/c3sl/blendb.git
npm install
```

### Running

```
npm start
```

## API Reference

Check the documentation  [here](https://gitlab.c3sl.ufpr.br/c3sl/blendb/raw/master/doc/api-v1-reference.html).

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting merge requests to us.

## License

This project is licensed under the GPLv3 License -- see the [LICENSE](LICENSE) file for details

## Built With

48
| [![express](https://gitlab.c3sl.ufpr.br/c3sl/blendb/raw/master/artwork/built-with/express.png)](https://expressjs.com) | [![TypeScript](https://gitlab.c3sl.ufpr.br/c3sl/blendb/raw/master/artwork/built-with/typescript.png)](https://www.typescriptlang.org/) | [![RAML](https://gitlab.c3sl.ufpr.br/c3sl/blendb/raw/master/artwork/built-with/raml.png)](http://raml.org/) |
Eduardo L. Buratti's avatar
Eduardo L. Buratti committed
49 50
|:---:|:---:|:---:|
|express|TypeScript|RAML|