Merge pull request #516 from IntersectMBO/readme-changes

readme

README.md

@@ -2,7 +2,7 @@
 
 Welcome to the official repository for the Constitution Committee Portal.
 
-The primary purpose of the solution is to host the Cardano Constitution and allow anyone to get familiar with it and follow its evolution over time. It also serves as the single point of truth for the Cardano Community members to see how Constitutional Committee members voted on a specific Governance Action, with the inclusion of their rationale. For members of the Constitutional Committee, it serves as a portal to add reasoning to their votes and prepare it as an off-chain resource to be attached to on-chain governance actions.
+The primary purpose of the solution is to host the Cardano Constitution and allow anyone to get familiar with it and follow the evolution over time. It also serves as the single point of truth for the Cardano Community members to see how Constitutional Committee members voted on a specific Governance Action, with the inclusion of their rationale. For members of the Constitutional Committee, it serves as a portal to add reasoning to their votes and prepare it as an off-chain resource to be attached to on-chain governance actions.
 
 ## Table of content:
 
@@ -11,7 +11,7 @@ The primary purpose of the solution is to host the Cardano Constitution and allo
 - [Tech stack](#tech-stack)
 - [Getting started](#getting-started)
 - [Usage](#usage)
-- [Environment Variables](#environment-variables) 
+- [Environment Variables](#environment-variables)
 - [API Documentation](#api-documentation)
 - [License](#license)
 
@@ -93,7 +93,7 @@ Before you begin setting up the application, you'll need to clone the repository
      ```
      Edit the .env file to reflect your local settings. Env variables description can be found [below](#environment-variables).
    - Run this command within folders: `frontend`, `worker-service`, `ipfs-service` to configure environment variables for all these services. Edit every .env file to reflect your local settings.
-     Important: for `worker-service` environment variables ensure the right credentials for connection to DB-SYNC Database 
+     Important: for `worker-service` environment variables ensure the right credentials for connection to DB-SYNC Database
 
 4. **Docker Setup:**
 
@@ -120,27 +120,32 @@ Before you begin setting up the application, you'll need to clone the repository
      ```
 
 6. **Create Super Admin**
-   
+
    A Super Admin should be created manually. To do that, run the following SQL queries on the Backend PostgreSQL database:
+
    1. Create super admin user with valid email address
+
    ```
    INSERT INTO users (email, status, role_id) VALUES ('[email protected]', 'active', (SELECT r.id FROM roles r WHERE r.code='super_admin'));
    ```
+
    2. Add permissions to super admin
+
    ```
    INSERT INTO user_permissions(user_id, permission_id)
    SELECT users.id, permissions.id
    FROM permissions
-   INNER join users on users.email 
+   INNER join users on users.email
    IN ('[email protected]')
    WHERE code IN ('manage_admins', 'manage_cc_members', 'add_constitution_version');
    ```
 
 ## Usage
 
 If the installation process passes successfully, the CC Portal is ready to use.
-   - Frontend should be available on the URL: `http://localhost:3000`.
-   - Backend shoul be available on the URL: `http://localhost:1337`.
+
+- Frontend should be available on the URL: `http://localhost:3000`.
+- Backend shoul be available on the URL: `http://localhost:1337`.
 
 ## Environment Variables
 
@@ -222,4 +227,4 @@ Access the API documentation at: [http://localhost:1337/api-docs](http://localho
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the MIT License.