Skip to content
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

docs: add web ui readme file #47

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,43 @@ This project is a simple web application that allows you to manage your Sail Hos
To install the project, you need to have Go installed on your machine.

First, clone the repository:

```bash
git clone https://github.com/sail-host/cloud.git
```

Then, install the dependencies:

```bash
go mod tidy
```

Install the web dependencies:

```bash
cd web && bun install
```

## Running the project

To run the project, you need to have Go installed on your machine.

```bash
make dev
```

Run only backend golang service:

```bash
make dev-api
```

## Project testing

```bash
make test
```

## License

This project is licensed under the MIT License. See the LICENSE file for more details.
This project is licensed under the MIT License. See the LICENSE file for more details.
118 changes: 25 additions & 93 deletions web/README.md
Original file line number Diff line number Diff line change
@@ -1,99 +1,31 @@
# Shadcn Admin Dashboard
# Web UI Documentation

Admin Dashboard UI crafted with Shadcn and Vite. Built with responsiveness and accessibility in mind.
## Overview

![alt text](public/images/shadcn-admin.png)

I've been creating dashboard UIs at work and for my personal projects. I always wanted to make a reusable collection of dashboard UI for future projects; and here it is now. While I've created a few custom components, some of the code is directly adapted from ShadcnUI examples.

> This is not a starter project (template) though. I'll probably make one in the future.

## Features

- Light/dark mode
- Responsive
- Accessible
- Sidebar and header layouts
- 10+ pages
- Extra custom components
This is the web interface component of the project, built using modern web technologies.

## Tech Stack

**UI:** [ShadcnUI](https://ui.shadcn.com) (TailwindCSS + RadixUI)

**Build Tool:** [Vite](https://vitejs.dev/)

**Routing:** [React Router](https://reactrouter.com/en/main)

**Type Checking:** [TypeScript](https://www.typescriptlang.org/)

**Linting/Formatting:** [Eslint](https://eslint.org/) & [Prettier](https://prettier.io/)

**Icons:** [Tabler Icons](https://tabler.io/icons)

## Run Locally

Clone the project

```bash
git clone https://github.com/satnaing/shadcn-admin.git
```

Go to the project directory

```bash
cd shadcn-admin
```

##### Run using bun

For better performance, consider using [Bun](https://bun.sh/).

Install `bun` for **macOS** and **Linux**.

```bash
# for macOS, Linux, and WSL
curl -fsSL https://bun.sh/install | bash
# to install a specific version
curl -fsSL https://bun.sh/install | bash -s "bun-v1.0.0"
- React
- TypeScript
- Tailwind CSS
- Shadcn UI Components

## Project Structure

```
web/
├── public/ # Static files
├── src/
│ ├── components/
│ │ ├── ui/ # Reusable UI components
│ │ └── providers/ # Providers
│ │ └── custom/ # Custom components
│ ├── pages/
│ │ └── auth/ # Authentication pages
│ ├── hooks/ # Custom React hooks
│ └── data/ # Static data and types
│ └── lib/ # Library
│ └── store/ # Zustand store
│ └── types/ # TypeScript types
```

Install `bun` for **Windows**.

```bash
powershell -c "irm bun.sh/install.ps1|iex"
```

Install dependencies

```bash
bun install
```

Start the server

```bash
bun run dev
```

##### Run using npm

Install dependencies

```bash
npm install
```

Start the server

```bash
npm run dev
```

## Author

Crafted with 🤍 by [@satnaing](https://github.com/satnaing)

## License

Licensed under the [MIT License](https://choosealicense.com/licenses/mit/)
Loading