Skip to content

Commit

Permalink
feat: project init structure with basic layout (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
rishavvajpayee authored Sep 28, 2024
1 parent 93e9402 commit 02d9156
Show file tree
Hide file tree
Showing 15 changed files with 1,407 additions and 55 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# IDEs and editors
.idea/
.vscode/
.env

# dependencies
/node_modules
/.pnp
Expand Down
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,54 @@ Allows users to search and play with various DiceDB commands in real-time.

This repository hosts frontend service implementation of the Playground.

## Prerequisites

Ensure you have the following installed:
- **Node.js** (v16.x or later)
- **Yarn** (or npm)
- **Next.js** (v13.x or later)

## Installation
Clone the repository and install the dependencies:

```bash
git clone <repository-url>
cd playground-web
npm install
```

## Development

To start the development server, run:

```bash
npm run dev
```

This will launch the app on [http://localhost:3000](http://localhost:3000). The app will automatically reload if you make changes to the code.

## Building for Production

To create a production build:

```bash
npm run build
```

After the build is complete, you can start the production server with:

```bash
npm run start
```

## Project Structure

The main components of the DiceDB Playground include:
- **Terminal Component**: A basic terminal interface for interacting with DiceDB commands.
- **Search Component**: Allows searching through mock commands or documentation.

Feel free to extend or modify the components to suit your needs.

## How to contribute

The Code Contribution Guidelines are published at [CONTRIBUTING.md](CONTRIBUTING.md); please read them before you start making any changes. This would allow us to have a consistent standard of coding practices and developer experience.
Expand Down
13 changes: 12 additions & 1 deletion next.config.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
/** @type {import('next').NextConfig} */
const nextConfig = {};
const nextConfig = {
images: {
remotePatterns: [
{
protocol: "https",
hostname: "dicedb.io",
port: "",
pathname: "/**",
},
],
},
};

export default nextConfig;
Loading

0 comments on commit 02d9156

Please sign in to comment.