michalmytych/solvable-app

Backend for an application for interactive learning of programming.

solvable-app's Issues

Add commands & stubs for creating services and repositories

Add mocking external service in tests

Add basic Breeze Auth

Change $data['key'] to data_get($data, 'key')

https://github.com/michalmytych/solvable-api/blob/c600cab8930e2fd7361ac22fdb706d97a5062c49/app/Services/SolutionValidationService.php#L100

Create group & course resources

Create real-time communication authorized channel between laravel api and frontend SPA app

Add interfaces for all of models repositories

Change laravel-mix to vite

Set up CI-CD pipeline with Github Actions

Uploading solution and getting feedback from external compiler service

Create Blade + TailwindCSS components library.

Needed components:

• Container - main page container (responsive)
• Nav Bar (top but also burger)
• Form (wrapper for inputs)
• Page Header
• Card - container for forms / entity displays / siders
• Input (email, password, submit, text, text-area, number, calendar, dynamic select-search, range picker)
• Date display (localized)
• Paragraph
• Time passed display (localized)
• Horizontal separator
• Steps for progress
• Skeleton
• Loader
• Dynamic search

Add switching between CodeExecutor services in adequate service provider

Refactor SolutionValidationService instance methods calls at ServiceSolution

Make sure Onion-like architecture is implemented properly

• Eloquent or Query Builder should be called only in repositories. Repositories should be called in Services. Services should be called inside Laravel infrastructure like Controllers, Commands, Jobs, Listeners etc.
• User data calls such as Auth::id() should be present only in Controllers or sometimes - if there is no other way - in Services.
• Try not to use Auth facade in business logic. Move facade calls to UserRepository, and inject user repository through interface everywhere you need to get authorized user data.

Fix: Tests fail when running github CI workflow

Create web controllers for Services logic.

Requirements

• Create Controllers that use logic from services under Controller/Web namespace.
• Web controllers should return blade views.
• You don't need to fill blade views content, but files should exist.
• Follow rules described here.

Guide

1. Setup app locally (described at README.md).
2. Make sure tests are passing.
3. Analyze API controllers and how services logic is used there.
4. If there's some business logic in controller action that should be placed in related service, move it.
5. Create web controllers under App\Http\Controllers\Web\... namespace. Use Laravel make command.
6. Follow naming conventions of resource controllers.
7. Create blade views files (empty) and return them with necessary data form web controllers actions.
8. Repeat for all models:

• User (Auth namespace)
• Course (Course namespace)
• Group (Course namespace)
• Problem (Problem namespace)
• CodeLanguage (Problem/CodeLanguage namespace)
• Solution (SolutionController) - may be hard.

9. In case of spotting some bug - create additional github issue.

Check if all routes are properly authorized - if find method returns only from request->users's items

Upgrade to PHP 8.1 & Laravel 10.x

Add Course and Group models, add actions for adding problems to group and course at them

Refactor remaining controllers logic into services

Make deletion of inital Course Group not allowed without deletion of whole course

Remove redundant authorize methods at requests & clean-up

Returning solution model from commit() action, updating solution code file as base_64

Add tags feature & ability to make coding problem public for all users

Services should not take laravel requests as parameters

• Services should take models or DTOs as parameters.
• Search for other places where this may occur

solvable-app/app/Services/Problem/ProblemService.php

Line 39 in 6f56654

public function createWithRelations(CreateRequest $createRequest): ?Problem

Api routes should always return JSON

At the moment, you must add Accept: application/json to every request, otherwise it responds with html.

Add contributing.md to docs

Add query params & filters for solutions

Update tests after adding course & group CRUD

First GUI: Livewire.

Install Laravel Pint and use it to format code.

Create permissions systems with laravel-spatie, add user roles, specify which actions can certain usert types perform