Skip to content

Commit

Permalink
feat: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AbigailDeng authored and AbigailDeng committed Jul 17, 2024
1 parent c15d20d commit a4b20b7
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <REDIS_HOST>, <REDIS_PORT>, and <REDIS_PASSWORD> in the .env file with your local Redis host address, port number, and password, respectively.

- <REDIS_HOST>: If running on the local machine, you can use 127.0.0.1 or localhost.
- <REDIS_PORT>: The default Redis port number is 6379. If you have not changed Redis's default configuration, you can use 6379.
- <REDIS_PASSWORD>: 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
Expand Down

0 comments on commit a4b20b7

Please sign in to comment.