https://github.com/adygcode/ict50220-saas-livewire-demos
https://github.com/adygcode/ict50220-saas-livewire-demos
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/adygcode/ict50220-saas-livewire-demos
- Owner: AdyGCode
- Created: 2023-11-03T10:09:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-13T06:19:25.000Z (over 2 years ago)
- Last Synced: 2025-01-22T00:16:35.894Z (over 1 year ago)
- Language: PHP
- Size: 503 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: ReadMe.md
Awesome Lists containing this project
README
# Laravel Livewire Component Demos
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
A Demonstration and Tutorials Project using Laravel Livewire
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://example.com)
Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `AdyGCode`, `ICT50220-SaaS-Livewire-Demos`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`
### Built With
* [![Laravel][Laravel.com]][Laravel-url]
* [![PHP 8][Php.net]][PHP-url]
* [![Livewire][Livewire]][Livewire-url]
* [![MariaDB][MariaDB]][MariaDB-url]
* [![TailwindCSS][TailwindCSS.com]][TailwindCSS-url]
* [![HTML5][HTML5]][HTML5-url]
* [![CSS3][CSS3]][CSS3-url]
* [![PHPStorm][PHPStorm]][PHPStorm-url]
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Prerequisites
This project requires the following to be installed:
* NPM
* PHP 8.2+
* MariaDB (or MySQL)
* Apache/NginX
#### Operating System Application Options
**Windows**
Recommend using Laragon
- Provides NPM, PHP, MariaDB/MySQL/PostgreSQL, Redis, Apache/NginX
Alternatives include:
- Docker is an alternative across Windows, Linux and MacOS
**MacOS**
Recommend [Laravel Herd](https://herd.laravel.com/) and [DBengin](https://dbngin.com/)
- DBengine provides PostgreSQL, MySQL, Redis.
- Herd provides PHP, NginX, DNSMasq.
Alternatives include:
- Docker is an alternative across Windows, Linux and MacOS
- Homebrew (to install locally executing options)
We recommend using Homebrew as a way to maintain and select items such as npm.
**Linux**
- Docker is a great way to provide development and testing environments
Alternatives include:
- natively installed packages
- other containerisation systems
### Installation
1. Clone the repo
```sh
git clone https://github.com/AdyGCode/ICT50220-SaaS-Livewire-Demos.git
```
2. Install NPM packages
```sh
npm install
```
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
## Roadmap
The main roadmap will be in the issues in this Repository.
- [X] 5-Star Rating #1
- [ ] Text Input #2
- [ ] Number Input #3
- [ ] Select Box #5
- [ ] Autocomplete #4
- [ ] Password Input #6
- [ ] Complexity gauge #7
- [ ] Checkbox #8
- [ ] On/Off switch #9
- [ ] Radio Group #10
- [ ] Tag List #11
- [ ] ...
- [ ] ..
See the [open issues](https://github.com/AdyGCode/ICT50220-SaaS-Livewire-Demos/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
If you wish to contribute then:
- fork the repository,
- select an issue to resolve, and
- create a branch for that issue.
You will then create the component and a Markdown document that:
- Explains in plain English terms how to create the component - step by step
- Explains its use with a simple demo
- Demonstrate its use in a sample static page
- Provide access to this "static" page via the home/welcome dashboard
> At this time, all Documentation is in the [Documentation](Documentation) folder.
During this process and at all times, conventional commit messages (https://www.conventionalcommits.org/en/v1.0.0/) will be used.
You may (it is preferable) create Pest (preferred) or Unit tests for the component and the code to verify it is performing as expected.
It is preferable for this to happen as part of the traditional TDD, Write Test, fail test, Write code to pass test, Write test... loop until the feature (or fix) is completed.
Once this is complete, you will:
- Create a pull request for the solution linking it to the issue
- Accept feedback from the project maintainers
- Fix the feedback issues if they exist
- Push changes as required...
- Once the pull request is accepted you will:
- Merge your pull request into the main branch
- Resolve any merge conflicts that may exist
- Delete the (local) branch to signify the feature is complete
> **New Features and Fixes should be on separate issues and branches.**
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
Project Link: [https://github.com/AdyGCode/ICT50220-SaaS-Livewire-Demos](https://github.com/AdyGCode/ICT50220-SaaS-Livewire-Demos)
## Acknowledgments and References
* []()
* []()
* []()
### References
- https://docs.github.com/en/get-started/quickstart/github-flow
- https://www.conventionalcommits.org/en/v1.0.0/
- https://daily-dev-tips.com/posts/git-basics-conventional-commits/
- https://dev.to/jordharr/an-introduction-to-conventional-commits-bd4
- https://www.jondjones.com/architecture/continuous-intergration/source-control/adding-conventional-commits-to-git/
- https://medium.com/neudesic-innovation/conventional-commits-a-better-way-78d6785c2e08
- https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/
- https://totaldebug.uk/posts/automated-release-with-semantic-release-and-commitizen/
[contributors-shield]: https://img.shields.io/github/contributors/AdyGCode/ICT50220-SaaS-Livewire-Demos.svg?style=for-the-badge
[contributors-url]: https://github.com/AdyGCode/ICT50220-SaaS-Livewire-Demos/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/AdyGCode/ICT50220-SaaS-Livewire-Demos.svg?style=for-the-badge
[forks-url]: https://github.com/AdyGCode/ICT50220-SaaS-Livewire-Demos/network/members
[stars-shield]: https://img.shields.io/github/stars/AdyGCode/ICT50220-SaaS-Livewire-Demos.svg?style=for-the-badge
[stars-url]: https://github.com/AdyGCode/ICT50220-SaaS-Livewire-Demos/stargazers
[issues-shield]: https://img.shields.io/github/issues/AdyGCode/ICT50220-SaaS-Livewire-Demos.svg?style=for-the-badge
[issues-url]: https://github.com/AdyGCode/ICT50220-SaaS-Livewire-Demos/issues
[license-shield]: https://img.shields.io/github/license/AdyGCode/ICT50220-SaaS-Livewire-Demos.svg?style=for-the-badge
[license-url]: https://github.com/AdyGCode/ICT50220-SaaS-Livewire-Demos/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/linkedin_username
[product-screenshot]: images/screenshot.png
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Php.net]: https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white
[PHP-url]: https://php.net
[Livewire]: https://img.shields.io/badge/livewire-E23744?style=for-the-badge&logo=livewire&logoColor=white
[Livewire-url]: https://laravel-livewire.com/
[MariaDB]: https://img.shields.io/badge/MariaDB-003545?style=for-the-badge&logo=mariadb&logoColor=white
[MariaDB-url]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[TailwindCSS.com]: https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white
[TailwindCSS-url]: https://tailwindcss.com/
[HTML5]:https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white
[HTML5-url]: https://example.com
[CSS3]: https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white
[CSS3-url]: https://example.com
[PHPStorm]: http://img.shields.io/badge/-PHPStorm-181717?style=for-the-badge&logo=phpstorm&logoColor=white
[PHPStorm-url]: https://jetbrains.com