Skip to content

Commit f207181

Browse files
committed
chore: add image on readme.md
1 parent 321d67b commit f207181

File tree

2 files changed

+25
-21
lines changed

2 files changed

+25
-21
lines changed

.github/redisolar.png

750 KB
Loading

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# RediSolar for Node.js
22

3+
<p align="center">
4+
<img src="https://i.ibb.co/QNKrq04/redisolar.png" alt="RediSolar"/>
5+
</p>
6+
37
# Introduction
48

59
This is the sample application codebase for RU102JS, [Redis for JavaScript Developers](https://university.redis.com/courses/ru102js/) at [Redis University](https://university.redis.com).
@@ -10,15 +14,15 @@ Solutions to the course programming challenges can be found on the `solutions` b
1014

1115
In order to start and run this application, you will need:
1216

13-
* [Node.js](https://nodejs.org/en/download/) (8.9.4 or newer, we recommend using the current Long Term Stable version)
14-
* npm (installed with Node.js)
15-
* Access to a local or remote installation of [Redis](https://redis.io/download) version 5 or newer (local preferred)
16-
* If you want to try the RedisTimeSeries exercises, you'll need to make sure that your Redis installation also has the [RedisTimeSeries Module](https://oss.redis.com/redistimeseries/) installed
17+
- [Node.js](https://nodejs.org/en/download/) (8.9.4 or newer, we recommend using the current Long Term Stable version)
18+
- npm (installed with Node.js)
19+
- Access to a local or remote installation of [Redis](https://redis.io/download) version 5 or newer (local preferred)
20+
- If you want to try the RedisTimeSeries exercises, you'll need to make sure that your Redis installation also has the [RedisTimeSeries Module](https://oss.redis.com/redistimeseries/) installed
1721

1822
If you're using Windows, check out the following resources for help with running Redis:
1923

20-
* [Redis Labs Blog - Running Redis on Windows 10](https://redis.com/blog/redis-on-windows-10/)
21-
* [Microsoft - Windows Subsystem for Linux Installation Guide for Windows 10](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
24+
- [Redis Labs Blog - Running Redis on Windows 10](https://redis.com/blog/redis-on-windows-10/)
25+
- [Microsoft - Windows Subsystem for Linux Installation Guide for Windows 10](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
2226

2327
# Setup
2428

@@ -28,12 +32,12 @@ To get started:
2832
$ npm install
2933
```
3034

31-
# Configuration
35+
# Configuration
3236

33-
The application uses a configuration file, `config.json` to specify the port that it listens
34-
on plus some logging parameters and how it connects to a database.
37+
The application uses a configuration file, `config.json` to specify the port that it listens
38+
on plus some logging parameters and how it connects to a database.
3539

36-
The supplied `config.json` file is already set up to use Redis on localhost port 6379. Change these values if your Redis instance is on another host or port, or requires a password to connect.
40+
The supplied `config.json` file is already set up to use Redis on localhost port 6379. Change these values if your Redis instance is on another host or port, or requires a password to connect.
3741

3842
```
3943
{
@@ -53,8 +57,8 @@ The supplied `config.json` file is already set up to use Redis on localhost port
5357
}
5458
```
5559

56-
The `keyPrefix` for Redis is used to namespace all the keys that the application generates or
57-
references. So for example a key `sites:999` would be `ru102js:sites:999` when written to Redis.
60+
The `keyPrefix` for Redis is used to namespace all the keys that the application generates or
61+
references. So for example a key `sites:999` would be `ru102js:sites:999` when written to Redis.
5862

5963
# Load Sample Data
6064

@@ -66,12 +70,12 @@ npm run load src/resources/data/sites.json flushdb
6670

6771
`flushdb` is optional, and will erase ALL data from Redis before inserting the sample data.
6872

69-
The application uses the key prefix `ru102js` by default, so you should be able to use the
73+
The application uses the key prefix `ru102js` by default, so you should be able to use the
7074
same Redis instance for this application and other data if necessary.
7175

7276
# Development Workflow
7377

74-
In order to speed up development, you can run the application using `nodemon`, so that any
78+
In order to speed up development, you can run the application using `nodemon`, so that any
7579
changes to source code files cause the server to reload and start using your changes.
7680

7781
```
@@ -90,15 +94,15 @@ But you will then need to stop the server and restart it when you change code.
9094

9195
# Accessing the Front End Web Application
9296

93-
You should be able to see the front end solar dashboard app at:
97+
You should be able to see the front end solar dashboard app at:
9498

9599
```
96100
http://localhost:8081/
97101
```
98102

99103
# Running Tests
100104

101-
The project is setup to use [Jest](https://jestjs.io/en/) for testing. To run all tests:
105+
The project is setup to use [Jest](https://jestjs.io/en/) for testing. To run all tests:
102106

103107
```
104108
npm test
@@ -110,7 +114,7 @@ To run a specific suite of tests (e.g. those in `tests/basic.test.js`):
110114
npm test -t basic
111115
```
112116

113-
To run Jest continuously in watch mode, which gives you access to menus allowing you to run
117+
To run Jest continuously in watch mode, which gives you access to menus allowing you to run
114118
subsets of tests and many more options:
115119

116120
```
@@ -119,12 +123,12 @@ npm testdev
119123

120124
# Linting
121125

122-
This project uses [ESLint](https://eslint.org/) with a slightly modified version of the
126+
This project uses [ESLint](https://eslint.org/) with a slightly modified version of the
123127
[Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
124128

125-
* The file `.eslintrc` contains a short list of rules that have been disabled for this project.
126-
* The file `.eslintignore` contains details of paths that the linter will not consider when
127-
linting the project.
129+
- The file `.eslintrc` contains a short list of rules that have been disabled for this project.
130+
- The file `.eslintignore` contains details of paths that the linter will not consider when
131+
linting the project.
128132

129133
To run the linter:
130134

0 commit comments

Comments
 (0)