Skip to content

Commit da962cf

Browse files
committed
Merge remote-tracking branch 'origin/feature/updates' into feature/updates
# Conflicts: # README.md
2 parents 134817f + 191a985 commit da962cf

File tree

2 files changed

+64
-1
lines changed

2 files changed

+64
-1
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Server Side Public License
1+
Server Side Public License
22
VERSION 1, OCTOBER 16, 2018
33

44
Copyright © 2018 MongoDB, Inc.

redisinsight/api/README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# RedisInsight API
2+
3+
## Description
4+
RedisInsight provides an intuitive and efficient GUI for Redis, allowing you to interact with your databases and manage your data—with built-in support for most popular Redis modules. It provides tools to analyze the memory, profile the performance of your database usage, and guide you toward better Redis usage.
5+
6+
## Prerequisites
7+
8+
Make sure you have installed following packages:
9+
* [Node](https://nodejs.org/en/download/) >= 8.0
10+
* [npm](https://www.npmjs.com/get-npm) >= 5
11+
12+
## Dependencies used
13+
* [NestJS](https://nestjs.com/)
14+
15+
## Getting started
16+
17+
### Installation
18+
19+
```bash
20+
$ yarn install
21+
```
22+
23+
### Running the app
24+
25+
```bash
26+
# development
27+
$ yarn start
28+
29+
# watch mode
30+
$ yarn start:dev
31+
32+
# production mode
33+
$ yarn start:prod
34+
```
35+
36+
### Formatting
37+
38+
Formatting required before submitting pull request.
39+
40+
Prints the filenames of files that are different from Prettier formatting
41+
```bash
42+
$ yarn format
43+
```
44+
### Swagger OpenApi
45+
46+
The [OpenAPI](https://swagger.io/specification/) specification is a language-agnostic definition format used
47+
to describe RESTful APIs.
48+
49+
While the application is running, open your browser and navigate to `http://localhost[:<port>]/api/docs`.
50+
You should see the Swagger UI.
51+
52+
### Test
53+
54+
```bash
55+
# unit tests
56+
$ yarn test
57+
58+
# e2e tests
59+
$ yarn test:e2e
60+
61+
# test coverage
62+
$ yarn test:cov
63+
```

0 commit comments

Comments
 (0)