Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(readme): add section why we choosen php and laravel #76

Merged
merged 2 commits into from
Dec 14, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<p align="center"><img src=".github/assets/RadioRoster.svg" alt="RadioRoster" width="150px"/><h1>RadioRoster API</h1></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://github.com/laravel/framework/actions"><img src="https://github.com/Lapotor/RadioRoster-api/actions/workflows/tests.yml/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/Lapotor/RadioRoster-api" alt="License"></a>
Expand All @@ -11,30 +11,38 @@

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.

### Prerequisites
### Why PHP and Laravel?

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.

- PHP 8.1 or higher
- Composer
- MariaDB, PostgreSQL, SQLite or another compatible database
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.

## Development

### Prerequisites

- PHP 8.1 or higher
- Composer
- MariaDB, PostgreSQL, SQLite or another compatible database

### Contribution

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:

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine:
```bash
git clone https://github.com/yourusername/radioroster-api.git
```
```bash
git clone https://github.com/yourusername/radioroster-api.git
```
3. Create a new branch for your contribution:
```bash
git checkout -b feature/new-feature
```
```bash
git checkout -b feature/new-feature
```
4. Make your changes and commit them with descriptive commit messages.
5. Push your changes to your forked repository:
```bash
git push origin feature/new-feature
```
```bash
git push origin feature/new-feature
```
6. Open a pull request on GitHub, comparing your branch to the `main` branch of the original repository.

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

### Acknowledgments

- The Laravel community for providing an excellent framework.
- The Laravel community for providing an excellent framework.