Merge pull request #81 from zuramai/2.0.0-rc.1

Merge v2.0.0-rc.1 branch

.github/workflows/demo.yml

@@ -0,0 +1,31 @@
+name: Deploy demo to docs
+
+# Will run on 2.0.0-rc.1 branch
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+
+      - name: Install and Build 🔧
+        run: |
+          npm install
+          npm run production
+          rm dist/.gitignore
+          
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: docs # The branch the action should deploy to.
+          folder: ./dist # The folder the action should deploy.
+          target-folder: demo # Deploy to `demo` folder in `docs` branch
+          commit-message: "update: demo"
+
+

.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version: 
+        required: true
+        type: string
+        description: Release version number (semver)
+      prerelease: 
+        required: false
+        default: false
+        type: boolean
+        description: Is it pre-release version?
+
+# on:
+#   workflow_dispatch:
+#     inputs:
+#       version: 
+#         required: true
+#         type: string
+#         description: Release version number (semver)
+#       prerelease: 
+#         required: false
+#         default: false
+#         type: boolean
+#         description: Is it pre-release version?
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+
+      - name: Install and Build 🔧
+        run: |
+          npm install
+          npm run production
+          rm dist/.gitignore
+          npm run zip
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          prerelease: ${{ github.event.inputs.prerelease }}
+          tag_name: ${{ github.event.inputs.version }}
+          files: |
+            dist.zip

.gitignore

@@ -4,3 +4,5 @@
 
 # ignore code scanning from package-lock
 package-lock.json
+
+dist.zip

CONTRIBUTING.md

@@ -8,8 +8,10 @@
 
 ## Note
 
-### CSS
-If you want to make some changes in the CSS style. Don't edit the `.css` file, use the SCSS file instead.
+Make sure to not commit generated files from your dist folder.
+All changes need to be made in the source files located in the `src` folder.
+- Change the `scss` files to adapt styles.
+- Change the nunjucks based `html` files or the content defining `json` files to adapt layout and content.
+- Change the `js` files to adapt the application code
 
-### HTML
-Since we use Nunjucks, if you want to make changes to the HTML structure, make sure you change the source file (Nunjucks) located in `src` then build the source file with `npm run watch`.
+Always run a build and test the results before committing.

README.md

@@ -1,6 +1,6 @@
 <h1 align="center">Mazer Dashboard</h1>
 
-![Screenshot](https://raw.githubusercontent.com/zuramai/mazer/main/screenshot.png)
+![Mazer Screenshot](https://user-images.githubusercontent.com/45036724/167523601-9d20fb17-1989-488f-b619-cb53c0db8898.png)
 
 <p align="center">Mazer is an Admin Dashboard Template that can help you develop faster. Made with Bootstrap 5. No jQuery dependency.</p>
 <div align="center">
@@ -17,19 +17,19 @@
 	<a href="http://zuramai.github.io/mazer/docs">Documentation Page</a>&nbsp;&nbsp;&nbsp;
 </p>
 
-## Installation
-
-1. Clone this repository or download as zip.
-
-```sh
-git clone https://github.com/zuramai/mazer
-```
-
-2. Open the `mazer/dist/index.html` file to see the dashboard.
+## Usage
+#### Using a ready-made built
+Download the latest release from the [releases page](https://github.com/zuramai/mazer/releases "releases page")
+Open the index HTML file and explore the source code.
+#### Building yourself
+- Clone the repository `git clone https://github.com/zuramai/mazer`
+- Install dependencies using the node package manager of your choice. For example run `npm install` 
+- Files are bundled by Laravel Mix to the dist folder.
+    - Either run `npm run hot` and open `http://localhost:8080` to see a hot-reloading copy of the generated files
+    - Or run `npm run watch`  (rebuilds on file changes) or `npm run production` and open `index.html` in from the dist folder.
 
 ## Community Mazer-based open sources
 
-- [Mazer Dark Mode](https://github.com/kazemyavari/mazer-dark) by [@kazemyavari](https://github.com/kazemyavari/mazer-dark) 
 - [CodeIgniter 4](https://github.com/irsyadulibad/mazer-codeigniter) by [@irsyadulibad](https://github.com/irsyadulibad)
 - [Laravel + Livewire](https://github.com/zuramai/laravel-mazer) (unmaintained, looking for maintainer)
 - [NuxtJS](https://github.com/fauzan121002/mazer-nuxt) by [@fncolon](https://github.com/fncolon)
@@ -40,15 +40,15 @@ git clone https://github.com/zuramai/mazer
 
 ## Contributing
 
-Please follow [Contributing Guide](./CONTRIBUTING.md) before contribute.
+Please follow [Contributing Guide](./CONTRIBUTING.md) before contributing.
 
 ## License
 
 Mazer is under [MIT License](./LICENSE).
 
 ## Author
 
-Mazer is created by <a href="https://ahmadsaugi.com">Ahmad Saugi</a>.
+Mazer is created by <a href="https://saugi.me">Saugi</a>.
 
 ## Donation
 

dist/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore