From a4b20b7e9b8551e8589b58bdfbc9eaa20a4ddd50 Mon Sep 17 00:00:00 2001 From: AbigailDeng Date: Wed, 17 Jul 2024 15:37:24 +0800 Subject: [PATCH] feat: readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 14b9091..01cb6fc 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,18 @@ Run the following command to copy the default example and replace with your own cp .env.example .env ``` +### Redis + +We use Redis optimized for fast reads locally. We do not need to use Redis in the production environment because we are using static exports. + +First, install Redis locally by running brew install redis. +Start the Redis service by running redis-server. You will see the Redis port number at this point. +Replace , , and in the .env file with your local Redis host address, port number, and password, respectively. + +- : If running on the local machine, you can use 127.0.0.1 or localhost. +- : The default Redis port number is 6379. If you have not changed Redis's default configuration, you can use 6379. +- : If your Redis server has password protection enabled, use the set password. If no password is set, you can leave it blank. + ### Run the development server ```bash