ISSUE-345: readme

Author: tatevikg1

README.md

@@ -15,7 +15,7 @@ phpList is an open source newsletter manager.
 ## About this package
 
 This module will contain the web frontend for phpList 4. It will not have any
-SQL queries, but use functionality from the phpList 4 core for DB access.
+SQL queries but use functionality from the phpList 4 core for DB access.
 
 This module is optional, i.e., it will be possible to run phpList 4 without a
 web frontend.
@@ -38,3 +38,7 @@ contribute and how to run the unit tests and style checks locally.
 This project adheres to a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
 By participating in this project and its community, you are expected to uphold
 this code.
+
+## Command to running this project for local testing
+
+symfony local:server:start

src/Controller/SecurityController.php renamed to src/Controller/AuthController.php

@@ -9,26 +9,22 @@
 use PhpList\WebFrontend\Service\ApiClient;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Routing\Attribute\Route;
 
-class SecurityController extends AbstractController
+class AuthController extends AbstractController
 {
     private ApiClient $apiClient;
-    private SessionInterface $session;
 
-    public function __construct(ApiClient $apiClient, RequestStack $requestStack)
+    public function __construct(ApiClient $apiClient)
     {
         $this->apiClient = $apiClient;
-        $this->session = $requestStack->getSession();
     }
 
     #[Route('/login', name: 'login', methods: ['GET', 'POST'])]
     public function login(Request $request): Response
     {
-        if ($this->session->has('auth_token')) {
+        if ($request->getSession()->has('auth_token')) {
             return $this->redirectToRoute('empty_start_page');
         }
 
@@ -40,8 +36,8 @@ public function login(Request $request): Response
 
             try {
                 $authData = $this->apiClient->authenticate($username, $password);
-                $this->session->set('auth_token', $authData['key']);
-                $this->session->set('auth_expiry_date', $authData['key']);
+                $request->getSession()->set('auth_token', $authData['key']);
+                $request->getSession()->set('auth_expiry_date', $authData['key']);
                 $this->apiClient->setAuthToken($authData['key']);
 
                 return $this->redirectToRoute('empty_start_page');
@@ -58,9 +54,9 @@ public function login(Request $request): Response
     }
 
     #[Route('/logout', name: 'logout')]
-    public function logout(): Response
+    public function logout(Request $request): Response
     {
-        $this->session->remove('auth_token');
+        $request->getSession()->remove('auth_token');
 
         return $this->redirectToRoute('login');
     }