Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 2.01 KB

README.md

File metadata and controls

92 lines (59 loc) · 2.01 KB

codecov Laravel TailwindCSS Vue.js

Planning Poker

Overview

This is a Planning Poker project developed using Laravel as the backend framework, Vue.js for the frontend, Inertia.js for the middle layer, and Ably for real-time communication.

Usage

Welcome Playing
First time Playing

Technologies Used

Requirements

Installation

  1. Clone the repository:
git clone https://github.com/naaando/planningpoker.git
  1. Copy the environment file:
cp .env.example .env
  1. Configure the environment file:

Open the .env file at the root of the project and configure your environment variables, including the database configuration and Ably credentials.

  1. Start the project with Sail:
./vendor/bin/sail up -d
  1. Install PHP dependencies:
./vendor/bin/sail composer install
  1. Generate the application key:
./vendor/bin/sail artisan key:generate
  1. Run database migrations:
./vendor/bin/sail artisan migrate
  1. Install Node.js dependencies:
./vendor/bin/sail npm install
  1. Compile assets:
./vendor/bin/sail npm run dev

Contributing

Contributions are welcome! Please follow the instructions in CONTRIBUTING.md.

License

This project is licensed under the MIT License.