From 139f90baacb17c12faa879bf9aa804db8896b0d3 Mon Sep 17 00:00:00 2001 From: Yoan Bernabeu Date: Fri, 20 Dec 2024 19:40:20 +0100 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20du=20README=20pour=20am?= =?UTF-8?q?=C3=A9liorer=20la=20clart=C3=A9=20des=20instructions=20de=20d?= =?UTF-8?q?=C3=A9veloppement=20local=20et=20modification=20du=20Makefile?= =?UTF-8?q?=20pour=20simplifier=20l'installation=20initiale=20et=20le=20d?= =?UTF-8?q?=C3=A9marrage=20du=20projet.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 8 ++- README.md | 121 ++++++++++++++++++++++++---------------------- package-lock.json | 2 +- 3 files changed, 66 insertions(+), 65 deletions(-) diff --git a/Makefile b/Makefile index a2ad4ee..67e8864 100644 --- a/Makefile +++ b/Makefile @@ -205,10 +205,10 @@ deploy: ## Deploy project. .PHONY: deploy start: ## Start project for local development. - $(MAKE) sf-dc $(MAKE) sf-dmm $(MAKE) sf-start $(MAKE) sf-open + $(SYMFONY_CONSOLE) tailwind:build --watch .PHONY: start #---------------------------------------------# @@ -226,11 +226,9 @@ before-commit: ## Run before commit. first-install: ## First install. $(MAKE) composer-install - $(MAKE) sf-perm + $(MAKE) npm-install $(MAKE) sf-dc - $(MAKE) sf-dmm - $(MAKE) sf-start - $(MAKE) sf-open + $(MAKE) start .PHONY: first-install stop: ## Stop project. diff --git a/README.md b/README.md index f6ae403..941adaf 100644 --- a/README.md +++ b/README.md @@ -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 + ``` -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). \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 9e595b7..28935cf 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "OpenStreamPoll", + "name": "app", "lockfileVersion": 3, "requires": true, "packages": {