Skip to content

Commit

Permalink
minor changes for v4
Browse files Browse the repository at this point in the history
  • Loading branch information
danny007in authored and REJack committed Aug 6, 2023
1 parent 23bdd76 commit 4553a24
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 21 deletions.
19 changes: 8 additions & 11 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Contributing to AdminLTE

Contributions are always **welcome and recommended**! Here is how for beginner's: [Get started with open source click here](https://youtu.be/GbqSvJs-6W4)
Expand All @@ -15,23 +14,21 @@ Contributions are always **welcome and recommended**! Here is how for beginner's
```bash
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
```
* Create a new branch
* Create a new branch from `master`
3. Compile dist files (Development) :
* To compile the dist files you need Node.js 10 or higher/npm (node package manager)
* Delete ./package-lock.json file
* To compile the dist files you need Node.js 18 or higher/npm (node package manager)
* `npm install` (install npm deps)
* `npm run dev` (developer mode, autocompile with browsersync support for live demo)
* Make your changes only in ./buid Folder OR package.json OR ./dist/js/demo.js OR in any html files which nessary to contribute
* Do not changes in ./dist/css/ AND ./dist/js/ Because its compiled files
* `npm run production` (compile css/js files and test every pages are perfectly working fine, before creating pull request)
4. Create a pull request
* Make your changes only in `./src` Folder OR `package.json` in any files which are necessary for contribution
* Do not make changes in `./dist/**` Because it contains compiled files and do not include in PR (Pull Request)
* `npm run production` (compile css/js files and test all pages are perfectly working fine, before creating a pull request)
4. Create a pull request to `master` branch

## Online one-click setup for contributing

You can use Gitpod(an online IDE which is free for Open Source) for working on issues or making Prs. With a single click it will launch a workspace and automatically:
You can use [Codespace](https://docs.github.com/en/codespaces) an online IDE which is free for Open Source for working on issues or making PRs (Pull Requests). With a single click it will launch a workspace and automatically:

- clone the `AdminLTE` repo.
- Open with [Codespace](https://docs.github.com/en/codespaces) or [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
- install the dependencies.
- run `npm run dev` to start the server.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
2 changes: 1 addition & 1 deletion .github/workflows/bundlewatch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ jobs:
run: npm run bundlewatch
env:
BUNDLEWATCH_GITHUB_TOKEN: "${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}"
CI_BRANCH_BASE: v4-dev
CI_BRANCH_BASE: master
4 changes: 2 additions & 2 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ name: "CodeQL"
on:
push:
branches:
- v4-dev
- master
- "!dependabot/**"
pull_request:
# The branches below must be a subset of the branches above
branches:
- v4-dev
- master
- "!dependabot/**"
schedule:
- cron: "0 0 * * 0"
Expand Down
2 changes: 1 addition & 1 deletion .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
tasks:
- init: npm install
command: npx gulp
command: npm run dev
ports:
- port: 3000
onOpen: open-preview
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
[![npm version](https://img.shields.io/npm/v/admin-lte/latest.svg)](https://www.npmjs.com/package/admin-lte)
[![Packagist](https://img.shields.io/packagist/v/almasaeed2010/adminlte.svg)](https://packagist.org/packages/almasaeed2010/adminlte)
[![cdn version](https://data.jsdelivr.com/v1/package/npm/admin-lte/badge)](https://www.jsdelivr.com/package/npm/admin-lte)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
[![Discord Invite](https://img.shields.io/badge/discord-join%20now-green)](https://discord.gg/jfdvjwFqfz)
[![Netlify Status](https://api.netlify.com/api/v1/badges/1277b36b-08f3-43fa-826a-4b4d24614b3c/deploy-status)](https://app.netlify.com/sites/adminlte-v4/deploys)

Expand Down Expand Up @@ -38,11 +37,11 @@ To compile the dist files you need Node.js/npm, clone/download the repo then:
- First thing first, you should have bit knowledge about NodeJS.
- Github Knowledge.
- Install NodeJS LTS version.
- Clone this Repository to your machine and change to `v4-dev` branch.
- Clone this Repository to your machine and change to `master` branch.
- Go to Cloned Folder.
- In cli/bash run `npm install` it will install dependency from `package.json`.
- After installation complets, run `npm run dev`
- Cool, Send urs changes in PR to `v4-dev` branch.
- Cool, Send urs changes in PR to `master` branch.


## License
Expand Down
6 changes: 3 additions & 3 deletions src/html/components/docs/how-to-contribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ Contributions are always **welcome and recommended**! Here is how for beginner's
```bash
git clone https://github.com/YOUR_USERNAME/AdminLTE.git
```
* Create a new branch from `v4-dev`
* Create a new branch from `master`
3. Compile dist files (Development) :
* To compile the dist files you need Node.js 18 or higher/npm (node package manager)
* `npm install` (install npm deps)
* `npm run dev` (developer mode, autocompile with browsersync support for live demo)
* Make your changes only in `./src` Folder OR `package.json` in any files which are necessary for contribution
* Do not make changes in `./dist/**` Because it contains compiled files and do not include in PR (Pull Request)
* `npm run production` (compile css/js files and test all pages are perfectly working fine, before creating a pull request)
4. Create a pull request to `v4-dev` branch
4. Create a pull request to `master` branch

## Online one-click setup for contributing

You can use [Codespace](https://docs.github.com/en/codespaces) an online IDE which is free for Open Source for working on issues or making PRs (Pull Requests). With a single click it will launch a workspace and automatically:

- clone the `AdminLTE` repo.
- Open with [Codespace](https://docs.github.com/en/codespaces)
- Open with [Codespace](https://docs.github.com/en/codespaces) or [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
- install the dependencies.
- run `npm run dev` to start the server.

0 comments on commit 4553a24

Please sign in to comment.