Goal<\/h5>\n\n\n\n
The essence of this tutorial is to learn how to integrate and manage data using Redis and TypeScript to implement the logic. This tutorial is meant to expose us to a full developer experience using Redis.<\/p>\n\n\n\n
What is TypeScript<\/h5>\n\n\n\n
TypeScript is an open-source strongly typed programming language that is embedded in JavaScript. Before using TypeScript you have to be familiar with JavaScript because it is a super-set of JavaScript.<\/p>\n\n\n\n
Prerequisite<\/h5>\n\n\n\n\n- Node Engine<\/li>\n\n\n\n
- Yarn or NPM installer<\/li>\n\n\n\n
- MySQL server<\/li>\n\n\n\n
- IDE (E.g: Visual Studio Code)<\/li>\n\n\n\n
- Knowledge of JavaScript<\/li>\n\n\n\n
- Familiar with TypeScript<\/li>\n<\/ul>\n\n\n\n
We are developing a simple fictitious Book Library API application where users can read e-books.<\/p>\n\n\n\n
Redis Set Up<\/h5>\n\n\n\n
To install Redis on your local machine use this link Redis Setup<\/a>. If you are using a Linux base OS (Ubuntu) like me then follow the instructions below.<\/p>\n\n\n\nInstall the lsb_release<\/strong> module:<\/p>\n\n\n\n# if this package is installed already on your machine please skip this step
> sudo apt install lsb-release<\/pre>\n\n\n\nAdd the repository to the Apt index:<\/p>\n\n\n\n
> curl -fsSL https:\/\/packages.redis.io\/gpg | sudo gpg --dearmor -o \/usr\/share\/keyrings\/redis-archive-keyring.gpg<\/pre>\n\n\n\n> echo \"deb [signed-by=\/usr\/share\/keyrings\/redis-archive-keyring.gpg] https:\/\/packages.redis.io\/deb $(lsb_release -cs) main\" | sudo tee \/etc\/apt\/sources.list.d\/redis.list<\/pre>\n\n\n\nUpdate your system dependency packages:<\/p>\n\n\n\n
sudo apt-get update<\/pre>\n\n\n\nInstall Redis with this command:<\/p>\n\n\n\n
> sudo apt install redis-stack-server<\/pre>\n\n\n\nTo enable Redis to start using the Ubuntu systemd init system, use the command below to open your redis.conf<\/code> file:<\/p>\n\n\n\n> sudo nano \/etc\/redis\/redis.conf<\/pre>\n\n\n\nThe supervised<\/code> directive is no<\/code> by default. Change the no<\/code> to systemd<\/code>.<\/p>\n\n\n\nInside the file, search for the supervised<\/code> directive and change it to systemd<\/code>:<\/p>\n\n\n\n...
supervised systemd
...<\/pre>\n\n\n\nSave the file and exit.<\/p>\n\n\n\n
Restart the Redis service to update your changes:<\/p>\n\n\n\n
sudo systemctl restart redis.service<\/pre>\n\n\n\nTo test that Redis has been installed and is functioning correctly run the command on your terminal:<\/p>\n\n\n\n
> redis-cli<\/pre>\n\n\n\nOutput:<\/p>\n\n\n\n
127.0.0.1:6379><\/pre>\n\n\n\nTest connectivity:<\/p>\n\n\n\n
127.0.0.1:6397>ping<\/pre>\n\n\n\nOutput:<\/p>\n\n\n\n
PONG<\/pre>\n\n\n\nThat’s it. Your Redis server is properly set up for use.<\/p>\n\n\n\n
Docker Set Up<\/h4>\n\n\n\n
Docker should be installed and functioning before installing the Redis Docker container. Use this link Docker Installation to set up Docker on your machine. Before installing the Redis Stack we need to understand that Redis has two Docker containers which are redis\/redis-stack<\/code> and redis\/redis-stack-server<\/code>. The redis\/redis-stack<\/code> container is suitable for development, it contains the Redis Stack Server and RedisInsight (RedisInsight is a Redis GUI visualization tool for visualizing and optimizing data in Redis) while redis\/redis-stack-server<\/code> container is for best production.<\/p>\n\n\n\nThis is personal, I prefer using the redis\/redis-stack-server<\/code> container to set up my Redis server.<\/p>\n\n\n\nTo download the Redis server container:<\/p>\n\n\n\n
> docker run -d --name redis-stack-server -p 6379:6379 redis\/redis-stack-server:latest<\/pre>\n\n\n\nUse the command below to ensure your Docker container is up and running. It will display all running containers:<\/p>\n\n\n\n
> docker ps<\/pre>\n\n\n\nf your Redis server container is running then you should have something similiar:<\/p>\n\n\n\n
Your container name and port number should be different from mine. I have another Redis container running.<\/p>\n\n\n\n![\"\"\/](\"https:\/\/drive.google.com\/uc?export=view&id=1dYIolOH_LUFfQf54-KGCGNH1DAo66FBR\")
<\/figure>\n\n\n\nLet’s get into our Redis container shell:<\/p>\n\n\n\n
> docker exec -t redis-stack-srv sh<\/pre>\n\n\n\nRun the Redis CLI:<\/p>\n\n\n\n
redis-cli<\/pre>\n\n\n\nYou will see the Redis prompt on your terminal or cmd.<\/p>\n\n\n\n
Output:<\/p>\n\n\n\n
127.0.0.1:6377><\/pre>\n\n\n\nYours should look like this: <\/strong>127.0.0.1:6379><\/strong><\/code><\/p>\n\n\n\nNow we have our Redis server running on our machine.<\/p>\n\n\n\n
Project Set Up<\/h4>\n\n\n\n
As I mentioned earlier we are developing a Book library API and we are using Express framework and TypeScript. Let’s create our project directory. Open your terminal and type the command below:<\/p>\n\n\n\n
Before typing the command, ensure you are in the directory where you want your project directory or folder to reside.<\/p>\n\n\n\n
mkdir ebook-redis-express-typescript<\/pre>\n\n\n\nCd (change directory) into your application folder. Enter the following commands on your terminal:<\/p>\n\n\n\n
yarn init -y<\/pre>\n\n\n\nSetup TypeScript on your application.<\/p>\n\n\n\n
I prefer installing TypeScript as a dev dependency on my projects. If you have TypeScript installed globally on your machine, skip the next step.<\/p>\n\n\n\n
yarn add -D typescript<\/pre>\n\n\n\nThe tsconfig.json<\/code> file is a TypeScript compiler file and it specifies compile options. Let’s generate the tsconfig.json<\/code> file:<\/p>\n\n\n\nnpx tsc --init<\/pre>\n\n\n\nIn your tsconfig.json<\/code> file, remove the comment, and update the following:<\/p>\n\n\n\n\"target\": \"ES2019\",
\"module\": \"CommonJS\",
\"moduleResolution\": \"node\",
\"outDir\": \".\/dist\"<\/pre>\n\n\n\nTime to install development packages.<\/p>\n\n\n\n
yarn add -D express redis-om nodemon<\/pre>\n\n\n\n\nExpress: A backend framework embedded on JavaScript for building RESTful applications.<\/p>\n\n\n\n
Nodemon: Monitors your scripts for changes (recommended during development. Not to be used for production).<\/p>\n\n\n\n
Redis: A Redis client for interacting with the Redis server.<\/p>\n\n\n\n
Redis OM: A Redis client for interacting with Redis server and also creating data models.<\/p>\n<\/blockquote>\n\n\n\n
# typescript definition packages
yarn add -D ts-node @types\/node @types\/express<\/pre>\n\n\n\nLet’s create our entry point script. Create a folder src<\/code> on the root folder of your application. Inside the src<\/code> folder create an app.ts<\/code> file.<\/p>\n\n\n\nmkdir src
\u200b
# CD into the src folder
cd src
\u200b
# inside source folder create an appt.ts script
touch app.ts<\/pre>\n\n\n\nInside your app.ts<\/code> script :<\/p>\n\n\n\nimport express from 'express';
\u200b
const app = express()
\u200b
app.use(express.json());
\u200b
const PORT = process.env.PORT || 3000
\u200b
app.listen(PORT, async () => {
console.log(`app is running on port ${PORT}`)
})<\/pre>\n\n\n\nLet’s set up the Redis connection. On the root folder of your application create .env<\/code><\/p>\n\n\n\nThe .env<\/code> file will contain the Redis server environment variables.<\/p>\n\n\n\nOpen your .env<\/code> file:<\/p>\n\n\n\nREDIS_URL=redis:\/\/localhost:6379<\/pre>\n\n\n\nWe need to install a dotenv<\/code> package that will enable our application to interact with our environment variables. Go to your terminal:<\/p>\n\n\n\nyarn add dotenv<\/pre>\n\n\n\nRedis Connection<\/h4>\n\n\n\n
The Redis client enables our application interacts with the Redis server.<\/p>\n\n\n\n
After the dotenv<\/code> package installation, inside the src<\/code> folder, create a connection.ts<\/code> script. The connection.ts<\/code> file will hold the Redis connection setup:<\/p>\n\n\n\nimport 'dotenv\/config'
import { Client } from 'redis-om'
\u200b
export default async function() {
const url = process.env.REDIS_URL
const client = new Client()
const redisConn = await client.open(url)
\u200b
\/\/ to check for connection. you can delete it after we have confirmed our connection is successful
const dbCheck = await client.execute(['PING']);
console.log(dbCheck)
return redisConn
}<\/pre>\n\n\n\nGo to your app.ts<\/code> and import the Redis connection:<\/p>\n\n\n\nimport express from 'express';
\/\/ Redis connection import
import RedisClient from '.\/connection';
\u200b
const app = express()
app.use(express.json());
\u200b
const PORT = process.env.PORT || 3000
\u200b
app.listen(PORT, async () => {
await RedisClient();
console.log(`app is running on port ${PORT}`)
})<\/pre>\n\n\n\nGo to your package.json<\/code> script and add the following:<\/p>\n\n\n\n...
\"scripts\": {
\"dev\": \"nodemon .\/src\/app.ts\"
},
...<\/pre>\n\n\n\nYour script should look like this:<\/p>\n\n\n\n
{
\"name\": \"ebook-redis-express-typescript\",
\"version\": \"1.0.0\",
\"main\": \"index.js\",
\"license\": \"MIT\",
\"scripts\": {
\"dev\": \"nodemon .\/src\/app.ts\"
},
\"dependencies\": {
\"dotenv\": \"^16.0.3\",
\"express\": \"^4.18.2\",
\"nodemon\": \"^2.0.20\",
\"redis\": \"^4.5.0\",
\"redis-om\": \"^0.3.6\"
},
\"devDependencies\": {
\"@types\/express\": \"^4.17.14\",
\"@types\/node\": \"^18.11.9\",
\"ts-node\": \"^10.9.1\",
\"typescript\": \"^4.9.3\"
}
}<\/pre>\n\n\n\nGo to your terminal and run:<\/p>\n\n\n\n
yarn dev<\/pre>\n\n\n\n![\"redis\"\/](\"https:\/\/drive.google.com\/uc?export=view&id=11o_rvVyfJcRemvV1aaYoPjO1VEiG1wP2\")
<\/figure>\n\n\n\nIf your terminal is looking like the image above that means your application is up and running as is supposed to, if you are experiencing any errors please go through the instructions again.<\/p>\n\n\n\n
The next phase is to set up the Book entity and this is where our Redis OM (Object Mapper) comes in handy.<\/p>\n\n\n\n
Redis OM<\/strong> enables us to use the RedisJSON to create JavaScript objects. RedisJSON is one of the Redis modules one can use to create and retrieve data in JSON format from the Redis database.<\/p>\n\n\n\nInside the src<\/code>folder create a repositories<\/code> folder that will hold the entity classes. Create a BookRepo.ts<\/code> script inside the entities folder:<\/p>\n\n\n\nYour file path should look like this: src\/repositories\/BookRepo.ts<\/code> . The Repository<\/strong> will provide us with the ability to carry out the CRUD (Create, Read, Update and Delete) functionalities on our application.<\/p>\n\n\n\nimport { Entity, Schema } from 'redis-om';
import redisClient from '..\/connection'
\u200b
class Book extends Entity {}
\u200b
const BookSchema: any = new Schema(Book, {
title: { type: 'string' },
author: { type: 'string' },
pages: { type: 'number' },
publisher: { type: 'string' },
category: { type: 'string' },
publishedDate: { type: 'date' },
},{
dataStructure: 'JSON'
});
\u200b
\u200b
const setup = async () => {
const bookRepo = (await redisClient()).fetchRepository(BookSchema)
await bookRepo.createIndex()
return bookRepo;
\u200b
}
\u200b
export default setup<\/pre>\n\n\n\nNext step is to set up the controller that will act as a middle man between Repository and the Routes. Create a controllers<\/code> folder inside the src<\/code> folder. Create a BookController.ts<\/code> inside the controllers<\/code> folder. In the script we will import the BookRepo<\/code> file:<\/p>\n\n\n\nFile path: src\/controllers\/BookController.ts<\/code><\/p>\n\n\n\nimport { Request, Response, NextFunction } from 'express'
import BookRepo from '..\/repositories\/BookRepo';
\u200b
export default class BookController {
public static createBook = async (req: Request, res: Response, next: NextFunction) => {
try {
const result = await (await BookRepo()).createAndSave(req.body)
\u200b
return res.send({
status: 'success',
data: result
})
} catch (error) {
next(error)
}
}
}<\/pre>\n\n\n\nLet’s set up the routes<\/code> file. Inside the src<\/code> folder create a routes.ts<\/code> file:<\/p>\n\n\n\nFile path: src\/routes.ts<\/code><\/p>\n\n\n\nimport express, { Router } from 'express';
import BookController from '.\/controllers\/BookController';
\u200b
const router = express.Router();
\u200b
router.post('\/book', BookController.createBook)
\u200b
export default router<\/pre>\n\n\n\nGo to your app.ts<\/code> and import your route file:<\/p>\n\n\n\nimport express from 'express';
import RedisClient from '.\/connection';
import router from '.\/routes';
\u200b
const app = express()
app.use(express.json());
\u200b
const PORT = process.env.PORT || 3000
\u200b
app.use('\/api\/v1', router);
\u200b
app.listen(PORT, async () => {
await RedisClient();
console.log(`app is running on port ${PORT}`)
})<\/pre>\n\n\n\nopen your Postman or any HTTP client you are familiar with setup the book object and hit this endpoint:<\/p>\n\n\n\n
localhost:3000\/api\/v1\/book<\/code><\/p>\n\n\n\n![\"\"\/](\"https:\/\/drive.google.com\/uc?export=view&id=1yrZ0Ypzp24SaH7w8DQzmrldC7C-EpsTr\")
<\/figure>\n\n\n\nLet’s fetch go ahead and fetch the book that was just created. Let’s create the endpoint. Go to your BookController.ts<\/code> and add the following method inside the BookController<\/code> class:<\/p>\n\n\n\n public static getBookById = async (req: Request, res: Response, next: NextFunction) => {
try {
const result = await (await BookRepo()).fetch(req.params.id)
\u200b
return res.send({
status: 'success',
data: result
})
} catch (error) {
next(error)
}
}<\/pre>\n\n\n\nGo to your routes.ts<\/code> and add the following endpoint:<\/p>\n\n\n\nrouter.get('\/book\/:id', BookController.getBookById)<\/pre>\n\n\n\nOn your Postman, hit the endpoint: localhost:3000\/api\/v1\/book\/<book_id><\/code><\/p>\n\n\n\n![\"\"\/](\"https:\/\/drive.google.com\/uc?export=view&id=1r-Q0-hDIpdkcv6gZqBOXURxoOcVAXG1r\")
<\/figure>\n\n\n\nBravo!<\/p>\n\n\n\n
We are able to fetch our book by the Id.<\/p>\n\n\n\n
Setting up a Redis server on your local machine is only suitable for development because data are being stored on the local memory. Imagine having a large data set, and developing an application that will be used by a large number of people. You cannot use your local machine as storage for such projects.<\/p>\n\n\n\n
Here is the catch! Redis has grown into a full-blown NoSQL database and has provided us with the Redis Enterprise Cloud for production-ready applications. In Part 2<\/a><\/strong> of this tutorial, we will learn how to integrate the Redis Enterprise Cloud<\/a><\/strong> into our application.<\/p>\n\n\n\n
REDIS Cloud Developers\u2019 Experience With TypeScript \u2013 Part 2<\/a><\/strong><\/p>\n\n\n\nMeet me in the comment section for questions and feedback.<\/p>\n\n\n\n
This post is in collaboration with Redis<\/a><\/strong><\/em><\/p>\n\n\n\n\n![\"\"](\"https:\/\/chigisoft.com\/blog\/wp-content\/uploads\/2023\/07\/Learn-product-design-with-Chigisoft-6-edited.png\")
<\/a><\/figure>\n<\/figure>\n\n\n\nRelated<\/h4>\n\n\n\n
Try Redis Cloud for free<\/a><\/strong><\/p>\n\n\n\nRedis Developer Hub – tools, guides, and tutorials about Redis<\/a><\/strong><\/p>\n\n\n\n
We are developing a simple fictitious Book Library API application where users can read e-books.<\/p>\n\n\n\n
Redis Set Up<\/h5>\n\n\n\n
To install Redis on your local machine use this link Redis Setup<\/a>. If you are using a Linux base OS (Ubuntu) like me then follow the instructions below.<\/p>\n\n\n\n Install the lsb_release<\/strong> module:<\/p>\n\n\n\n Add the repository to the Apt index:<\/p>\n\n\n\n Update your system dependency packages:<\/p>\n\n\n\n Install Redis with this command:<\/p>\n\n\n\n To enable Redis to start using the Ubuntu systemd init system, use the command below to open your The Inside the file, search for the Save the file and exit.<\/p>\n\n\n\n Restart the Redis service to update your changes:<\/p>\n\n\n\n To test that Redis has been installed and is functioning correctly run the command on your terminal:<\/p>\n\n\n\n Output:<\/p>\n\n\n\n Test connectivity:<\/p>\n\n\n\n Output:<\/p>\n\n\n\n That’s it. Your Redis server is properly set up for use.<\/p>\n\n\n\n Docker should be installed and functioning before installing the Redis Docker container. Use this link Docker Installation to set up Docker on your machine. Before installing the Redis Stack we need to understand that Redis has two Docker containers which are This is personal, I prefer using the To download the Redis server container:<\/p>\n\n\n\n Use the command below to ensure your Docker container is up and running. It will display all running containers:<\/p>\n\n\n\n f your Redis server container is running then you should have something similiar:<\/p>\n\n\n\n Your container name and port number should be different from mine. I have another Redis container running.<\/p>\n\n\n\n Let’s get into our Redis container shell:<\/p>\n\n\n\n Run the Redis CLI:<\/p>\n\n\n\n You will see the Redis prompt on your terminal or cmd.<\/p>\n\n\n\n Output:<\/p>\n\n\n\n Yours should look like this: <\/strong> Now we have our Redis server running on our machine.<\/p>\n\n\n\n As I mentioned earlier we are developing a Book library API and we are using Express framework and TypeScript. Let’s create our project directory. Open your terminal and type the command below:<\/p>\n\n\n\n Before typing the command, ensure you are in the directory where you want your project directory or folder to reside.<\/p>\n\n\n\n Cd (change directory) into your application folder. Enter the following commands on your terminal:<\/p>\n\n\n\n Setup TypeScript on your application.<\/p>\n\n\n\n I prefer installing TypeScript as a dev dependency on my projects. If you have TypeScript installed globally on your machine, skip the next step.<\/p>\n\n\n\n The In your Time to install development packages.<\/p>\n\n\n\n Express: A backend framework embedded on JavaScript for building RESTful applications.<\/p>\n\n\n\n Nodemon: Monitors your scripts for changes (recommended during development. Not to be used for production).<\/p>\n\n\n\n Redis: A Redis client for interacting with the Redis server.<\/p>\n\n\n\n Redis OM: A Redis client for interacting with Redis server and also creating data models.<\/p>\n<\/blockquote>\n\n\n\n Let’s create our entry point script. Create a folder Inside your Let’s set up the Redis connection. On the root folder of your application create The Open your We need to install a The Redis client enables our application interacts with the Redis server.<\/p>\n\n\n\n After the Go to your Go to your Your script should look like this:<\/p>\n\n\n\n Go to your terminal and run:<\/p>\n\n\n\n If your terminal is looking like the image above that means your application is up and running as is supposed to, if you are experiencing any errors please go through the instructions again.<\/p>\n\n\n\n The next phase is to set up the Book entity and this is where our Redis OM (Object Mapper) comes in handy.<\/p>\n\n\n\n Redis OM<\/strong> enables us to use the RedisJSON to create JavaScript objects. RedisJSON is one of the Redis modules one can use to create and retrieve data in JSON format from the Redis database.<\/p>\n\n\n\n Inside the Your file path should look like this: Next step is to set up the controller that will act as a middle man between Repository and the Routes. Create a File path: Let’s set up the File path: Go to your open your Postman or any HTTP client you are familiar with setup the book object and hit this endpoint:<\/p>\n\n\n\n Let’s fetch go ahead and fetch the book that was just created. Let’s create the endpoint. Go to your Go to your On your Postman, hit the endpoint: Bravo!<\/p>\n\n\n\n We are able to fetch our book by the Id.<\/p>\n\n\n\n Setting up a Redis server on your local machine is only suitable for development because data are being stored on the local memory. Imagine having a large data set, and developing an application that will be used by a large number of people. You cannot use your local machine as storage for such projects.<\/p>\n\n\n\n Here is the catch! Redis has grown into a full-blown NoSQL database and has provided us with the Redis Enterprise Cloud for production-ready applications. In Part 2<\/a><\/strong> of this tutorial, we will learn how to integrate the Redis Enterprise Cloud<\/a><\/strong> into our application.<\/p>\n\n\n\n Meet me in the comment section for questions and feedback.<\/p>\n\n\n\n This post is in collaboration with Redis<\/a><\/strong><\/em><\/p>\n\n\n\n Try Redis Cloud for free<\/a><\/strong><\/p>\n\n\n\n Redis Developer Hub – tools, guides, and tutorials about Redis<\/a><\/strong><\/p>\n\n\n\n# if this package is installed already on your machine please skip this step
> sudo apt install lsb-release<\/pre>\n\n\n\n> curl -fsSL https:\/\/packages.redis.io\/gpg | sudo gpg --dearmor -o \/usr\/share\/keyrings\/redis-archive-keyring.gpg<\/pre>\n\n\n\n
> echo \"deb [signed-by=\/usr\/share\/keyrings\/redis-archive-keyring.gpg] https:\/\/packages.redis.io\/deb $(lsb_release -cs) main\" | sudo tee \/etc\/apt\/sources.list.d\/redis.list<\/pre>\n\n\n\n
sudo apt-get update<\/pre>\n\n\n\n
> sudo apt install redis-stack-server<\/pre>\n\n\n\n
redis.conf<\/code> file:<\/p>\n\n\n\n> sudo nano \/etc\/redis\/redis.conf<\/pre>\n\n\n\n
supervised<\/code> directive is no<\/code> by default. Change the no<\/code> to systemd<\/code>.<\/p>\n\n\n\nsupervised<\/code> directive and change it to systemd<\/code>:<\/p>\n\n\n\n...
supervised systemd
...<\/pre>\n\n\n\nsudo systemctl restart redis.service<\/pre>\n\n\n\n
> redis-cli<\/pre>\n\n\n\n
127.0.0.1:6379><\/pre>\n\n\n\n
127.0.0.1:6397>ping<\/pre>\n\n\n\n
PONG<\/pre>\n\n\n\n
Docker Set Up<\/h4>\n\n\n\n
redis\/redis-stack<\/code> and redis\/redis-stack-server<\/code>. The redis\/redis-stack<\/code> container is suitable for development, it contains the Redis Stack Server and RedisInsight (RedisInsight is a Redis GUI visualization tool for visualizing and optimizing data in Redis) while redis\/redis-stack-server<\/code> container is for best production.<\/p>\n\n\n\nredis\/redis-stack-server<\/code> container to set up my Redis server.<\/p>\n\n\n\n> docker run -d --name redis-stack-server -p 6379:6379 redis\/redis-stack-server:latest<\/pre>\n\n\n\n
> docker ps<\/pre>\n\n\n\n
<\/figure>\n\n\n\n
> docker exec -t redis-stack-srv sh<\/pre>\n\n\n\n
redis-cli<\/pre>\n\n\n\n
127.0.0.1:6377><\/pre>\n\n\n\n
127.0.0.1:6379><\/strong><\/code><\/p>\n\n\n\nProject Set Up<\/h4>\n\n\n\n
mkdir ebook-redis-express-typescript<\/pre>\n\n\n\n
yarn init -y<\/pre>\n\n\n\n
yarn add -D typescript<\/pre>\n\n\n\n
tsconfig.json<\/code> file is a TypeScript compiler file and it specifies compile options. Let’s generate the tsconfig.json<\/code> file:<\/p>\n\n\n\nnpx tsc --init<\/pre>\n\n\n\n
tsconfig.json<\/code> file, remove the comment, and update the following:<\/p>\n\n\n\n\"target\": \"ES2019\",
\"module\": \"CommonJS\",
\"moduleResolution\": \"node\",
\"outDir\": \".\/dist\"<\/pre>\n\n\n\nyarn add -D express redis-om nodemon<\/pre>\n\n\n\n
\n
# typescript definition packages
yarn add -D ts-node @types\/node @types\/express<\/pre>\n\n\n\nsrc<\/code> on the root folder of your application. Inside the src<\/code> folder create an app.ts<\/code> file.<\/p>\n\n\n\nmkdir src
\u200b
# CD into the src folder
cd src
\u200b
# inside source folder create an appt.ts script
touch app.ts<\/pre>\n\n\n\napp.ts<\/code> script :<\/p>\n\n\n\nimport express from 'express';
\u200b
const app = express()
\u200b
app.use(express.json());
\u200b
const PORT = process.env.PORT || 3000
\u200b
app.listen(PORT, async () => {
console.log(`app is running on port ${PORT}`)
})<\/pre>\n\n\n\n.env<\/code><\/p>\n\n\n\n.env<\/code> file will contain the Redis server environment variables.<\/p>\n\n\n\n.env<\/code> file:<\/p>\n\n\n\nREDIS_URL=redis:\/\/localhost:6379<\/pre>\n\n\n\n
dotenv<\/code> package that will enable our application to interact with our environment variables. Go to your terminal:<\/p>\n\n\n\nyarn add dotenv<\/pre>\n\n\n\n
Redis Connection<\/h4>\n\n\n\n
dotenv<\/code> package installation, inside the src<\/code> folder, create a connection.ts<\/code> script. The connection.ts<\/code> file will hold the Redis connection setup:<\/p>\n\n\n\nimport 'dotenv\/config'
import { Client } from 'redis-om'
\u200b
export default async function() {
const url = process.env.REDIS_URL
const client = new Client()
const redisConn = await client.open(url)
\u200b
\/\/ to check for connection. you can delete it after we have confirmed our connection is successful
const dbCheck = await client.execute(['PING']);
console.log(dbCheck)
return redisConn
}<\/pre>\n\n\n\napp.ts<\/code> and import the Redis connection:<\/p>\n\n\n\nimport express from 'express';
\/\/ Redis connection import
import RedisClient from '.\/connection';
\u200b
const app = express()
app.use(express.json());
\u200b
const PORT = process.env.PORT || 3000
\u200b
app.listen(PORT, async () => {
await RedisClient();
console.log(`app is running on port ${PORT}`)
})<\/pre>\n\n\n\npackage.json<\/code> script and add the following:<\/p>\n\n\n\n...
\"scripts\": {
\"dev\": \"nodemon .\/src\/app.ts\"
},
...<\/pre>\n\n\n\n{
\"name\": \"ebook-redis-express-typescript\",
\"version\": \"1.0.0\",
\"main\": \"index.js\",
\"license\": \"MIT\",
\"scripts\": {
\"dev\": \"nodemon .\/src\/app.ts\"
},
\"dependencies\": {
\"dotenv\": \"^16.0.3\",
\"express\": \"^4.18.2\",
\"nodemon\": \"^2.0.20\",
\"redis\": \"^4.5.0\",
\"redis-om\": \"^0.3.6\"
},
\"devDependencies\": {
\"@types\/express\": \"^4.17.14\",
\"@types\/node\": \"^18.11.9\",
\"ts-node\": \"^10.9.1\",
\"typescript\": \"^4.9.3\"
}
}<\/pre>\n\n\n\nyarn dev<\/pre>\n\n\n\n
<\/figure>\n\n\n\n
src<\/code>folder create a repositories<\/code> folder that will hold the entity classes. Create a BookRepo.ts<\/code> script inside the entities folder:<\/p>\n\n\n\nsrc\/repositories\/BookRepo.ts<\/code> . The Repository<\/strong> will provide us with the ability to carry out the CRUD (Create, Read, Update and Delete) functionalities on our application.<\/p>\n\n\n\nimport { Entity, Schema } from 'redis-om';
import redisClient from '..\/connection'
\u200b
class Book extends Entity {}
\u200b
const BookSchema: any = new Schema(Book, {
title: { type: 'string' },
author: { type: 'string' },
pages: { type: 'number' },
publisher: { type: 'string' },
category: { type: 'string' },
publishedDate: { type: 'date' },
},{
dataStructure: 'JSON'
});
\u200b
\u200b
const setup = async () => {
const bookRepo = (await redisClient()).fetchRepository(BookSchema)
await bookRepo.createIndex()
return bookRepo;
\u200b
}
\u200b
export default setup<\/pre>\n\n\n\ncontrollers<\/code> folder inside the src<\/code> folder. Create a BookController.ts<\/code> inside the controllers<\/code> folder. In the script we will import the BookRepo<\/code> file:<\/p>\n\n\n\nsrc\/controllers\/BookController.ts<\/code><\/p>\n\n\n\nimport { Request, Response, NextFunction } from 'express'
import BookRepo from '..\/repositories\/BookRepo';
\u200b
export default class BookController {
public static createBook = async (req: Request, res: Response, next: NextFunction) => {
try {
const result = await (await BookRepo()).createAndSave(req.body)
\u200b
return res.send({
status: 'success',
data: result
})
} catch (error) {
next(error)
}
}
}<\/pre>\n\n\n\nroutes<\/code> file. Inside the src<\/code> folder create a routes.ts<\/code> file:<\/p>\n\n\n\nsrc\/routes.ts<\/code><\/p>\n\n\n\nimport express, { Router } from 'express';
import BookController from '.\/controllers\/BookController';
\u200b
const router = express.Router();
\u200b
router.post('\/book', BookController.createBook)
\u200b
export default router<\/pre>\n\n\n\napp.ts<\/code> and import your route file:<\/p>\n\n\n\nimport express from 'express';
import RedisClient from '.\/connection';
import router from '.\/routes';
\u200b
const app = express()
app.use(express.json());
\u200b
const PORT = process.env.PORT || 3000
\u200b
app.use('\/api\/v1', router);
\u200b
app.listen(PORT, async () => {
await RedisClient();
console.log(`app is running on port ${PORT}`)
})<\/pre>\n\n\n\nlocalhost:3000\/api\/v1\/book<\/code><\/p>\n\n\n\n<\/figure>\n\n\n\n
BookController.ts<\/code> and add the following method inside the BookController<\/code> class:<\/p>\n\n\n\n public static getBookById = async (req: Request, res: Response, next: NextFunction) => {
try {
const result = await (await BookRepo()).fetch(req.params.id)
\u200b
return res.send({
status: 'success',
data: result
})
} catch (error) {
next(error)
}
}<\/pre>\n\n\n\nroutes.ts<\/code> and add the following endpoint:<\/p>\n\n\n\nrouter.get('\/book\/:id', BookController.getBookById)<\/pre>\n\n\n\nlocalhost:3000\/api\/v1\/book\/<book_id><\/code><\/p>\n\n\n\n<\/figure>\n\n\n\n
REDIS Cloud Developers\u2019 Experience With TypeScript \u2013 Part 2<\/a><\/strong><\/p>\n\n\n\n<\/a><\/figure>\n<\/figure>\n\n\n\nRelated<\/h4>\n\n\n\n