Skip to content

Commit 3a8bab2

Browse files
authored
Merge pull request #19 from LuizHAP/feature/readme-changes
chore: add image on readme.md Closes #18.
2 parents 321d67b + a217f54 commit 3a8bab2

File tree

3 files changed

+23
-21
lines changed

3 files changed

+23
-21
lines changed

.github/redisolar.png

750 KB
Loading

README.md

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

3+
![Preview of running application - Solar Site Map with markers](preview.png)
4+
35
# Introduction
46

57
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 +12,15 @@ Solutions to the course programming challenges can be found on the `solutions` b
1012

1113
In order to start and run this application, you will need:
1214

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
15+
- [Node.js](https://nodejs.org/en/download/) (8.9.4 or newer, we recommend using the current Long Term Stable version)
16+
- npm (installed with Node.js)
17+
- Access to a local or remote installation of [Redis](https://redis.io/download) version 5 or newer (local preferred)
18+
- 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
1719

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

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)
22+
- [Redis Labs Blog - Running Redis on Windows 10](https://redis.com/blog/redis-on-windows-10/)
23+
- [Microsoft - Windows Subsystem for Linux Installation Guide for Windows 10](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
2224

2325
# Setup
2426

@@ -28,12 +30,12 @@ To get started:
2830
$ npm install
2931
```
3032

31-
# Configuration
33+
# Configuration
3234

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.
35+
The application uses a configuration file, `config.json` to specify the port that it listens
36+
on plus some logging parameters and how it connects to a database.
3537

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.
38+
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.
3739

3840
```
3941
{
@@ -53,8 +55,8 @@ The supplied `config.json` file is already set up to use Redis on localhost port
5355
}
5456
```
5557

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.
58+
The `keyPrefix` for Redis is used to namespace all the keys that the application generates or
59+
references. So for example a key `sites:999` would be `ru102js:sites:999` when written to Redis.
5860

5961
# Load Sample Data
6062

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

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

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

7274
# Development Workflow
7375

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

7779
```
@@ -90,15 +92,15 @@ But you will then need to stop the server and restart it when you change code.
9092

9193
# Accessing the Front End Web Application
9294

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

9597
```
9698
http://localhost:8081/
9799
```
98100

99101
# Running Tests
100102

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

103105
```
104106
npm test
@@ -110,7 +112,7 @@ To run a specific suite of tests (e.g. those in `tests/basic.test.js`):
110112
npm test -t basic
111113
```
112114

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

116118
```
@@ -119,12 +121,12 @@ npm testdev
119121

120122
# Linting
121123

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

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.
127+
- The file `.eslintrc` contains a short list of rules that have been disabled for this project.
128+
- The file `.eslintignore` contains details of paths that the linter will not consider when
129+
linting the project.
128130

129131
To run the linter:
130132

preview.png

1000 KB
Loading

0 commit comments

Comments
 (0)