Skip to content

Commit

Permalink
- Update Readme
Browse files Browse the repository at this point in the history
Took 10 minutes
  • Loading branch information
Cybrarist committed Sep 29, 2024
1 parent 442f66b commit 4916a44
Showing 1 changed file with 57 additions and 66 deletions.
123 changes: 57 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,57 @@
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>

<p align="center">
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
</p>

## About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

- [Simple, fast routing engine](https://laravel.com/docs/routing).
- [Powerful dependency injection container](https://laravel.com/docs/container).
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
- [Robust background job processing](https://laravel.com/docs/queues).
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).

Laravel is accessible, powerful, and provides tools required for large, robust applications.

## Learning Laravel

Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.

If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.

## Laravel Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).

### Premium Partners

- **[Vehikl](https://vehikl.com/)**
- **[Tighten Co.](https://tighten.co)**
- **[WebReinvent](https://webreinvent.com/)**
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
- **[64 Robots](https://64robots.com)**
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
- **[Cyber-Duck](https://cyber-duck.co.uk)**
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
- **[Jump24](https://jump24.co.uk)**
- **[Redberry](https://redberry.international/laravel/)**
- **[Active Logic](https://activelogic.com)**
- **[byte5](https://byte5.de)**
- **[OP.GG](https://op.gg)**

## Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).

## Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).

## Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## License

The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
![FreePalestine](./extra/palestine.png)

# Discount Bandit
Discount Bandit is a price tracker across multiple shopping websites simultaneously, and get notified when an item reaches the price you desire, so you don't have to keep checking shop stores for price changes.

# Documentation
Feel free to access the up-to-date documentation from [Here](https://discount-bandit.cybrarist.com)

## Deployment
Discount Bandit uses a web interface, so you need to install some dependencies first:
- php (https://www.php.net)
- composer (https://getcomposer.org)
- apache or nginx (https://httpd.apache.org , https://www.nginx.com)
- mysql (https://www.mysql.com)
- sqlite (Default Option)

or you can install something like MAMP instead of installing each one alone. (https://www.mamp.info/en/windows/)


first, you need to install the packages with composer
```bash
composer install
```

then run the following and follow the prompts
```text
php artisan discount:install
```
To make it easier for everyone, whether you are self hosting or just want to use the software, i have found that
https://ntfy.sh is the best solution. you can install their app from google play / appstore
and can setup the notification very easily.

You can also setup telegram notifications.

# Updating
If you updating the system, please run the following command

```text
php artisan discount:update
```
# CronJob
The previous command will give the output if whether you want to run app in the terminal or as cron for windows, mac and linux.

# Updates
If you want to update the code, after installing the new version run the following
```text
php artisan discount:update
```
## Connect
If you are coming outside github or don't like to use it, feel free to join my discord.
https://discord.gg/VBMHvH8tuR

## Docker
There is no docker image for beta, since i might need the flexibility to push updates or fix bugs.

## Sponsors
![Jetbrains](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)

0 comments on commit 4916a44

Please sign in to comment.