Skip to content

Commit ea6bb6d

Browse files
authored
chore(readme): add section why we choosen php and laravel (#76)
Signed-off-by: Valentin Sickert <[email protected]>
1 parent a1aa608 commit ea6bb6d

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<p align="center"><img src=".github/assets/RadioRoster.svg" alt="RadioRoster" width="150px"/><h1>RadioRoster API</h1></p>
22

33
<!--<p align="center">
4-
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
4+
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/Lapotor/RadioRoster-api/actions/workflows/tests.yml/badge.svg" alt="Build Status"></a>
55
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
66
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
77
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/Lapotor/RadioRoster-api" alt="License"></a>
@@ -11,30 +11,38 @@
1111

1212
RadioRoster is a comprehensive web-based system designed to streamline the scheduling of radio shows and facilitate interaction with listeners through wishes and greetings. Our platform empowers radio stations and broadcasters to efficiently manage their programming while providing an engaging experience for their audience.
1313

14-
### Prerequisites
14+
### Why PHP and Laravel?
15+
16+
We have chosen PHP as our server-side scripting language primarily because it is widely supported by most shared web hosting providers. This allows RadioRoster to be easily deployed on various hosting environments, making it accessible to a broader audience.
1517

16-
- PHP 8.1 or higher
17-
- Composer
18-
- MariaDB, PostgreSQL, SQLite or another compatible database
18+
In our search for a well-known and trusted PHP framework, Laravel emerged as the natural choice. Laravel is a highly regarded PHP framework for web applications, known for its elegant syntax, robust features, and developer-friendly environment. Many big companies trust Laravel for building scalable and efficient web applications.
1919

2020
## Development
2121

22+
### Prerequisites
23+
24+
- PHP 8.1 or higher
25+
- Composer
26+
- MariaDB, PostgreSQL, SQLite or another compatible database
27+
28+
### Contribution
29+
2230
We welcome contributions from the community! Whether you're a developer, designer, or enthusiast, your input can help make RadioRoster even better. Here are some guidelines to get you started:
2331

2432
1. Fork the repository on GitHub.
2533
2. Clone your forked repository to your local machine:
26-
```bash
27-
git clone https://github.com/yourusername/radioroster-api.git
28-
```
34+
```bash
35+
git clone https://github.com/yourusername/radioroster-api.git
36+
```
2937
3. Create a new branch for your contribution:
30-
```bash
31-
git checkout -b feature/new-feature
32-
```
38+
```bash
39+
git checkout -b feature/new-feature
40+
```
3341
4. Make your changes and commit them with descriptive commit messages.
3442
5. Push your changes to your forked repository:
35-
```bash
36-
git push origin feature/new-feature
37-
```
43+
```bash
44+
git push origin feature/new-feature
45+
```
3846
6. Open a pull request on GitHub, comparing your branch to the `main` branch of the original repository.
3947

4048
Before submitting a pull request, please ensure that your code is properly tested. Write tests for any new features or changes you introduce.
@@ -45,4 +53,4 @@ The RadioRoster API is licensed under the [AGPL-3.0 License](LICENSE).
4553

4654
### Acknowledgments
4755

48-
- The Laravel community for providing an excellent framework.
56+
- The Laravel community for providing an excellent framework.

0 commit comments

Comments
 (0)