Update READMe and remove github workflows
This commit is contained in:
82
README.md
82
README.md
@@ -1,64 +1,58 @@
|
||||
# Nuxt Starter Template
|
||||
# Dashlio
|
||||
|
||||
[](https://ui.nuxt.com)
|
||||
A dynamic, YAML-driven dashboard application.
|
||||
|
||||
Use this template to get started with [Nuxt UI](https://ui.nuxt.com) quickly.
|
||||
## Setup & Installation
|
||||
|
||||
- [Live demo](https://starter-template.nuxt.dev/)
|
||||
- [Documentation](https://ui.nuxt.com/docs/getting-started/installation/nuxt)
|
||||
### 1. Build the Docker Image
|
||||
|
||||
<a href="https://starter-template.nuxt.dev/" target="_blank">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://ui.nuxt.com/assets/templates/nuxt/starter-dark.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://ui.nuxt.com/assets/templates/nuxt/starter-light.png">
|
||||
<img alt="Nuxt Starter Template" src="https://ui.nuxt.com/assets/templates/nuxt/starter-light.png" width="830" height="466">
|
||||
</picture>
|
||||
</a>
|
||||
First, you need to build the Docker image for the project. You can do this by using the provided PowerShell script or manually via the Docker CLI.
|
||||
|
||||
> The starter template for Vue is on https://github.com/nuxt-ui-templates/starter-vue.
|
||||
**Option A: Using the build script (Windows/PowerShell)**
|
||||
1. Set up the build script with your details. If you haven't already, copy the example script:
|
||||
```powershell
|
||||
cp docker-build.example.ps1 docker-build.ps1
|
||||
```
|
||||
2. Edit `docker-build.ps1` to include your correct image details and tags.
|
||||
3. Run the script:
|
||||
```powershell
|
||||
.\docker-build.ps1
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash [Terminal]
|
||||
npm create nuxt@latest -- -t ui
|
||||
**Option B: Manual Build**
|
||||
Alternatively, you can build the image manually using the Docker CLI:
|
||||
```bash
|
||||
docker build -t dashlio .
|
||||
```
|
||||
|
||||
## Deploy your own
|
||||
### 2. Run the Docker Container
|
||||
|
||||
[](https://vercel.com/new/clone?repository-name=starter&repository-url=https%3A%2F%2Fgithub.com%2Fnuxt-ui-templates%2Fstarter&demo-image=https%3A%2F%2Fui.nuxt.com%2Fassets%2Ftemplates%2Fnuxt%2Fstarter-dark.png&demo-url=https%3A%2F%2Fstarter-template.nuxt.dev%2F&demo-title=Nuxt%20Starter%20Template&demo-description=A%20minimal%20template%20to%20get%20started%20with%20Nuxt%20UI.)
|
||||
|
||||
## Setup
|
||||
|
||||
Make sure to install the dependencies:
|
||||
Next, run the Docker container. Ensure you map the container to port `3000` and mount your `dashboard.yml` configuration file.
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
docker run -d \
|
||||
--name dashlio \
|
||||
-p 3000:3000 \
|
||||
-v ./app/dashboard.yml:/app/app/dashboard.yml \
|
||||
dashlio
|
||||
```
|
||||
|
||||
## Development Server
|
||||
*(Note: If you are using `docker-compose.yml`, you can also bring up the stack with `docker compose up -d`)*
|
||||
|
||||
Start the development server on `http://localhost:3000`:
|
||||
### 3. Configure Your Dashboard
|
||||
|
||||
With the container running (or before you start it), modify the `app/dashboard.yml` file. Set up your folders, links, and other module configurations exactly how you want your dashboard to look.
|
||||
|
||||
### 4. Restart to Rebuild
|
||||
|
||||
After you have modified `app/dashboard.yml`, you need to restart the Docker container. Restarting will trigger a rebuild of the Nuxt app inside the container to apply your changes.
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
docker restart dashlio
|
||||
```
|
||||
|
||||
## Production
|
||||
### 5. Access Your Dashboard
|
||||
|
||||
Build the application for production:
|
||||
You're all set! Open your browser and access your shiny new dashboard at:
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
Locally preview production build:
|
||||
|
||||
```bash
|
||||
pnpm preview
|
||||
```
|
||||
|
||||
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
|
||||
|
||||
## Renovate integration
|
||||
|
||||
Install [Renovate GitHub app](https://github.com/apps/renovate/installations/select_target) on your repository and you are good to go.
|
||||
**[http://localhost:3000](http://localhost:3000)**
|
||||
|
||||
Reference in New Issue
Block a user