From fd4af8428b1b561092cfa0662fdaf4c7dbe9a07f Mon Sep 17 00:00:00 2001 From: Kamran Zafar <91176244+kamranzafar4343@users.noreply.github.com> Date: Wed, 28 Aug 2024 16:23:46 +0500 Subject: [PATCH 1/2] Update Readme.txt Feat: "Write readme" --- Readme.txt | 79 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 73 insertions(+), 6 deletions(-) diff --git a/Readme.txt b/Readme.txt index 2302da0..d079238 100644 --- a/Readme.txt +++ b/Readme.txt @@ -1,11 +1,78 @@ -NiceAdmin is a powerful admin and dashboard template based latest version of Bootstrap framework. It provides a clean and intuitive design that is focused on user experience. The custom plugins included has been carefully customized to fit with the overall look of the theme, working seamlessly across browsers, tablets and phones. -NiceAdmin comes with lots of reusable and beautiful UI elements and components like tables, charts, login form, registration form, profile page and many more. It will just fit to any app and project you're building. -NiceAdmin template has a fully responsive layout. It displays perfectly on all the modern displays and resolutions from regular desktop screens to tablets, iPads, iPhones and small mobile devices. +# PHP Admin Panel -Sass/SCSS source files included (pro and membership users only) +## Overview -Pages Hirearchy: +This project is a PHP-based admin panel designed to manage and interact with various administrative functions. It features a user-friendly interface to perform CRUD operations and manage data efficiently. --> Dashboad.php \ No newline at end of file +## Features + +- **User Authentication**: Secure login and registration system. +- **Dashboard**: Overview of key metrics and admin functions. +- **CRUD Operations**: Create, Read, Update, and Delete data entries. +- **Responsive Design**: Works on both desktop and mobile devices. +- **Data Management**: Easily manage users, settings, and other essential data. + +## Installation + +### Prerequisites + +- PHP 7.4 or higher +- MySQL or MariaDB +- A web server like Apache or Nginx + +### Steps + +1. **Clone the Repository:** + ```bash + git clone https://github.com/yourusername/your-repository.git + ``` + +2. **Navigate to the Project Directory:** + ```bash + cd your-repository + ``` + +3. **Configure the Database:** + - Create a MySQL database and user. + - Import the database schema from `catmarketing.sql`. + +4. **Install Dependencies:** + - If you are using Composer for managing PHP dependencies, run: + ```bash + composer install + ``` + +5. **Set Up the Web Server:** + - Configure your web server to point to the `public` directory of this project. + +6. **Access the Admin Panel:** + - Open your browser and go to `http://localhost/your-repository/public` to access the admin panel. + +## Usage + +- **Login**: Use the credentials you set up during installation to log in. +- **Dashboard**: Navigate through different sections using the sidebar. +- **CRUD Operations**: Use the provided forms and interfaces to manage your data. + + +## Contributing + +1. Fork the repository. +2. Create a feature branch (`git checkout -b feature/YourFeature`). +3. Commit your changes (`git commit -am 'Add new feature'`). +4. Push to the branch (`git push origin feature/YourFeature`). +5. Create a new Pull Request. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## Contact + +For any questions or issues, please contact kamranzafar4343@gmail.com + +--- + +Feel free to adjust the details based on your specific project needs and structure! From b6c43a84372524f2bbbc17762b738c17b45e069d Mon Sep 17 00:00:00 2001 From: Kamran Zafar <91176244+kamranzafar4343@users.noreply.github.com> Date: Wed, 28 Aug 2024 16:24:47 +0500 Subject: [PATCH 2/2] Create php.yml --- .github/workflows/php.yml | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/php.yml diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml new file mode 100644 index 0000000..7d257b5 --- /dev/null +++ b/.github/workflows/php.yml @@ -0,0 +1,39 @@ +name: PHP Composer + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +permissions: + contents: read + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Validate composer.json and composer.lock + run: composer validate --strict + + - name: Cache Composer packages + id: composer-cache + uses: actions/cache@v3 + with: + path: vendor + key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} + restore-keys: | + ${{ runner.os }}-php- + + - name: Install dependencies + run: composer install --prefer-dist --no-progress + + # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit" + # Docs: https://getcomposer.org/doc/articles/scripts.md + + # - name: Run test suite + # run: composer run-script test