Valkey.io

This repo contains the source for the valkey.io website (build scripts, template, blog posts, stylesheets, etc.). The build integrates content from valkey-io/valkey-doc and the commands definitions from valkey-io/valkey (see Build Locally below for more details).

Contributing

We welcome contributions! Please see our CONTRIBUTING page to learn more about how to contribute to the website.

Security

If you discover potential security issues, see the reporting instructions on our CONTRIBUTING page for more information.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (version 16 or higher)
• pnpm (version 8.15.1 or higher)

Installation

1. Clone the repository:

git clone https://github.com/yourusername/valkey.io.git
cd valkey.io

2. Install dependencies:

pnpm install

Development

To start the development server:

pnpm dev

This will start the development server at http://localhost:5173

Building for Production

To create a production build:

pnpm build

The built files will be in the dist directory.

To preview the production build locally:

pnpm preview

Scripts

• pnpm dev - Start development server
• pnpm build - Create production build
• pnpm lint - Run ESLint
• pnpm preview - Preview production build

Tech Stack

• React 18
• TypeScript
• Vite
• ESLint
• Node.js

Project Structure

valkey.io/
├── src/           # Source files
├── public/        # Static files
├── dist/         # Built files (after running build)
└── package.json  # Project configuration

License

MIT