-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Mise à jour du README pour améliorer la clarté des instructions de dé…
…veloppement local et modification du Makefile pour simplifier l'installation initiale et le démarrage du projet.
- Loading branch information
1 parent
eea5d10
commit 139f90b
Showing
3 changed files
with
66 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,93 +1,96 @@ | ||
# OpenStreamPoll | ||
|
||
OpenStreamPoll is an open-source live polling platform built for streamers. | ||
OpenStreamPoll is an open-source live polling platform designed specifically for streamers. It empowers creators to engage their audience with instant polls, real-time results, and seamless integration with popular streaming tools. | ||
|
||
--- | ||
|
||
## Features | ||
|
||
- Create instant polls with multiple options | ||
- Real-time results updates | ||
- OBS integration ready | ||
- Built-in anti-cheat system | ||
- Mobile-friendly interface | ||
- Docker-ready deployment | ||
- **Instant Poll Creation:** Set up live polls effortlessly with multiple customizable options. | ||
- **Real-Time Results:** Display dynamic updates to keep your audience engaged. | ||
- **OBS Integration:** Designed to work flawlessly with OBS for professional streams. | ||
- **Anti-Cheat Protection:** Ensures fair and authentic voting. | ||
- **Mobile-Friendly Interface:** Optimized for all devices, making participation easy. | ||
- **Docker-Ready Deployment:** Simplifies setup and scalability. | ||
|
||
--- | ||
|
||
## Prerequisites (Local Development) | ||
## Prerequisites for Local Development | ||
|
||
To get started locally, ensure you have the following installed: | ||
|
||
- PHP 8.3 or higher | ||
- Composer | ||
- Symfony CLI | ||
- Node.js & NPM | ||
- SQLite | ||
- Make | ||
- Docker | ||
|
||
--- | ||
|
||
## Local Development Setup | ||
|
||
1. Clone the repository: | ||
```bash | ||
git clone https://github.com/yoanbernabeu/OpenStreamPoll.git | ||
cd OpenStreamPoll | ||
``` | ||
Follow these steps to run the project locally: | ||
|
||
2. Install dependencies: | ||
```bash | ||
composer install | ||
npm install | ||
``` | ||
1. **Clone the Repository:** | ||
```bash | ||
git clone https://github.com/yoanbernabeu/OpenStreamPoll.git | ||
cd OpenStreamPoll | ||
``` | ||
|
||
3. Configure your environment: | ||
```bash | ||
cp .env .env.local | ||
``` | ||
Edit `.env.local` and set your database configuration. | ||
2. **Initial Installation:** | ||
```bash | ||
make first-install | ||
``` | ||
|
||
4. Set up the database: | ||
```bash | ||
symfony console doctrine:database:create | ||
symfony console doctrine:migrations:migrate | ||
``` | ||
3. **Launch the Development Server:** | ||
```bash | ||
make start | ||
``` | ||
The application will be accessible at: `http://localhost:8000` (or an alternative port if 8000 is unavailable). | ||
|
||
5. Start the development server: | ||
```bash | ||
symfony serve -d | ||
symfony console tailwind:build --watch | ||
``` | ||
4. **Create an Admin User:** | ||
```bash | ||
symfony console app:create-user <username> <password> | ||
``` | ||
|
||
The application will be available at: `http://localhost:8000` (or another port if 8000 is in use). | ||
5. **Access the Admin Interface:** | ||
Navigate to: `http://localhost:8000/admin` | ||
|
||
6. Create an admin user: | ||
```bash | ||
symfony console app:create-user username password | ||
``` | ||
--- | ||
|
||
7. Access the admin interface: | ||
## Production Deployment | ||
|
||
The admin interface will be available at: `http://localhost:8000/admin` | ||
> **Note:** Secure your server before deploying this application to production. If you are not familiar with server security best practices, consider using a managed hosting provider. | ||
## Production Deployment | ||
1. **Clone the Repository:** | ||
```bash | ||
git clone https://github.com/yoanbernabeu/OpenStreamPoll.git | ||
cd OpenStreamPoll | ||
``` | ||
|
||
> Please, secure your server before deploying this application to production. If you are not familiar with server security, consider using a managed hosting provider. | ||
2. **Start the Application:** | ||
```bash | ||
make start | ||
``` | ||
|
||
1. Clone the repository: | ||
```bash | ||
git clone git clone https://github.com/yoanbernabeu/OpenStreamPoll.git | ||
cd OpenStreamPoll | ||
``` | ||
--- | ||
|
||
1. Let the magic happen: | ||
```bash | ||
make start | ||
``` | ||
## Usage Guide | ||
|
||
## Usage | ||
1. **Create a Poll:** Use the admin interface to set up a new poll. | ||
2. **Share the Link:** Distribute the poll's public URL to your audience. | ||
3. **Monitor Results:** View live updates to track audience responses. | ||
4. **Stream Results:** Seamlessly display live results during your stream. | ||
|
||
1. Create a new poll from the admin interface | ||
2. Share the public URL with your audience | ||
3. Monitor results in real-time | ||
4. Display results during your stream | ||
--- | ||
|
||
## Contributing | ||
|
||
No contributions at the moment, this is a personal project that I am making public for fun. No time to manage PRs at the moment. | ||
Currently, contributions are not being accepted as this is a personal project shared for public use. While PRs are welcome, they may not be actively managed at this time. | ||
|
||
--- | ||
|
||
## License | ||
|
||
This project is open-source and available under the [MIT License](LICENSE). | ||
OpenStreamPoll is open-source and distributed under the [MIT License](LICENSE). |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.