Skip to content

feat: project init structure with basic layout #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Sep 28, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
168 changes: 165 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,12 @@
"type-check": "tsc --noEmit"
},
"dependencies": {
"autoprefixer": "^10.4.20",
"lucide-react": "^0.446.0",
"next": "14.2.13",
"react": "^18",
"react-dom": "^18"
"react-dom": "^18",
"react-terminal-ui": "^1.3.0"
},
"devDependencies": {
"@types/node": "^20",
Expand Down
6 changes: 6 additions & 0 deletions postcss.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module.exports = {
plugins: {
tailwindcss: {},
autoprefixer: {},
},
}
Binary file removed public/logo.png
Binary file not shown.
16 changes: 4 additions & 12 deletions src/app/page.tsx
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
import Image from "next/image";
import Playground from "@/components/Playground/Playground";

export default function Home() {
return (
<div className="grid grid-rows-[20px_1fr_20px] items-center justify-items-center min-h-screen p-8 pb-20 gap-16 sm:p-20 font-[family-name:var(--font-geist-sans)]">
<main className="flex flex-col gap-8 row-start-2 items-center sm:items-start">
<Image
src="/logo.png"
alt="Next.js logo"
width={180}
height={38}
priority
/>
<main>
<Playground />
</main>
</div>
);
}
}
Loading
Loading