An open API service indexing awesome lists of open source software.

https://github.com/cable8mm/laravel-theme

This is the official laravel theme for Document2
https://github.com/cable8mm/laravel-theme

document2 laravel theme

Last synced: 8 months ago
JSON representation

This is the official laravel theme for Document2

Awesome Lists containing this project

README

          

# Laravel theme for Document2

[![js-tests](https://github.com/cable8mm/laravel-theme/actions/workflows/js-tests.yml/badge.svg)](https://github.com/cable8mm/laravel-theme/actions/workflows/js-tests.yml)
![GitHub Release](https://img.shields.io/github/v/release/cable8mm/laravel-theme)
![GitHub License](https://img.shields.io/github/license/cable8mm/Laravel-theme)

This is the official laravel theme for [Document2](https://github.com/cable8m/document2).

## Features

- [x] JAM stack supported
- [x] Tailwindcss and Vite
- [x] Dark Mode
- [x] Integration with the Document2

![Laravel Theme Preview](https://cabinet.palgle.com/laravel-theme-preview.png)

## Local Development

If you want to work on this project on your local machine, you may follow the instructions below.:

1. Fork this repository
2. Open your terminal and `cd` to your project folder
3. Clone your fork into the project folder, by running the following command *with your username placed into the {username} slot*:

```bash
git clone git@github.com:{username}/laravel-theme laravel-theme
```

4. CD into the new directory you just created:

```bash
cd laravel-theme
```

5. Run the `npm install` script, which will take all the steps necessary to prepare your local install:

```bash
npm install
```

6. Run the `npm run dev` script, which will provide local web server to `http://localhost:{port}`

```bash
npm run dev
```

### Syncing Upstream Changes Into Your Fork

This [GitHub article](https://help.github.com/en/articles/syncing-a-fork) provides instructions on how to pull the latest changes from this repository into your fork.