Contributing

We welcome contributions! Please follow these general rules to keep the process smooth.

General Rules

• Be Nice: We are all doing this for fun. Please keep a positive attitude. 😇
• Discuss First: Don't create Pull Requests without opening an issue to discuss the benefit and implications.
• Branching: All Pull Requests should be performed on the dev branch.
• Scope: We aim to keep the UI clean. Not every feature request will be approved if it bloats the interface.

Backend Development

1. Install: PHP >= 8.1 and Composer.
2. Run:

   cd back
   composer install
   cp .env.example .env
   php artisan serve
   

Frontend Development

1. Install: Node.js (LTS recommended).
2. Have a backend avaiable to connect to:
   • Either use your deployed Docker instance.
   • Or dev running backend like above.
3. Run:

   cd front
   npm install
   npm start