Change of .md files for better dev experience. (#147)

* Update README.md

Just a little visual update to the README.md file for better user experience while checking the app out.

* Update CONTRIBUTING.md

Updated CONTRIBUTING.md for better visual nesting to guide the future contributors step by step.

* Improved Documentation

Improved Documentation with slight visual changes that reduce the confusion in following of the documentation.

CONTRIBUTING.md

@@ -1,41 +1,52 @@
 ## How to Contribute
 
-1. Click the **Fork** button at the top right corner of the repository page on GitHub.
-2. GitHub will create a copy (fork) of the project in your account.
-3. **Clone** the forked repository to your local machine:
-   ```bash
-   git clone https://github.com/your-username/project-name.git
-   ```
-4. **Checkout a new branch locally**:
-   ```bash
-   git checkout -b branch-name
-   ```
-5. **Make your changes** to the code.
-6. **Add and commit** your changes:
-   ```bash
-   git add .
-   git commit -m "Description of your changes"
-   ```
-7. **Push** your changes to your fork:
-   ```bash
-   git push origin branch-name
-   ```
-8. **Create a Pull Request**:
+1. **Fork the Repository**:
+   - Click the **Fork** button in the top right corner of this repository page on GitHub.
+   - GitHub will create a copy (fork) of the project in your account.
+
+2. **Clone the Forked Repository**:
+   - Clone the repository to your local machine:
+     ```bash
+     git clone https://github.com/your-username/project-name.git
+     ```
+
+3. **Create a New Branch**:
+   - Check out a new branch locally to work on your changes:
+     ```bash
+     git checkout -b branch-name
+     ```
+
+4. **Make Changes**:
+   - Make your desired changes to the codebase.
+
+5. **Commit Your Changes**:
+   - Stage and commit your changes:
+     ```bash
+     git add .
+     git commit -m "Description of your changes"
+     ```
+
+6. **Push Your Changes**:
+   - Push your branch to your forked repository on GitHub:
+     ```bash
+     git push origin branch-name
+     ```
+
+7. **Create a Pull Request**:
    - Go to your forked repository on GitHub.
-   - Click the **Contribute** button.
-     Click the **Open pull request** button.
-   - Compare your changes with the main branch of the original repository.
+   - Click the **Contribute** button, then select **Open pull request**.
+   - Compare your branch with the main branch of the original repository.
    - Add a description of your changes and click **Create pull request**.
 
 ## Contribution Guidelines
 
 - Follow the project's coding style and conventions.
-- Add tests for any new features.
+- Add tests for any new features or changes.
 - Update the documentation as needed.
-- Be respectful and constructive in your communication.
+- Maintain respectful and constructive communication.
 
 ## Contact
 
-If you have any questions or need assistance, feel free to contact us at [email protected].
+If you have any questions or need assistance, please contact us at [[email protected]](mailto:[email protected]).
 
 Thank you for contributing!

README.md

@@ -2,76 +2,74 @@
 
 This application is designed for tracking buses in the city of Zenica, Bosnia and Herzegovina.
 
-Deployment: https://kadjebus.zeforge.ba
+**Deployment**: [Zenica Bus Tracking](https://kadjebus.zeforge.ba)
 
-Figma Idea #1 Project File Link: https://www.figma.com/design/Evsz1Ttu66byoB9j1dneq6/Untitled?node-id=2-2&t=tdBFS2mRirxmebKC-1
+## Project Design
 
-Figma Idea #2 Project File Link: https://www.figma.com/design/5fO5ky3p3nOG1QhNoGyefi/Kad-je-bus?node-id=0-1&t=CgSKo3MISOQGqgrU-1
+- **Figma Idea #1**: [View Project on Figma](https://www.figma.com/design/Evsz1Ttu66byoB9j1dneq6/Untitled?node-id=2-2&t=tdBFS2mRirxmebKC-1)
+- **Figma Idea #2**: [View Project on Figma](https://www.figma.com/design/5fO5ky3p3nOG1QhNoGyefi/Kad-je-bus?node-id=0-1&t=CgSKo3MISOQGqgrU-1)
 
-Link to ZeForge Discord server: https://discord.gg/x2enz95pDF
+**Join our Community**: [ZeForge Discord server](https://discord.gg/x2enz95pDF)
+
+---
 
 ## Getting Started
 
 ### Prerequisites
 
 Make sure you have the following installed:
 
-- Node.js (https://nodejs.org/en/download/package-manager)
-- pnpm (https://pnpm.io/installation)
+- **Node.js**: [Download Node.js](https://nodejs.org/en/download/package-manager)
+- **pnpm**: [Install pnpm](https://pnpm.io/installation)
 
 ### Installation
 
-1. **Install dependencies:**
+1. **Install dependencies**:
 
    ```bash
    pnpm install
    ```
 
-2. **Set up the Frontend:**
-
+2. **Frontend Setup**:
 
-   **For local development**, create a `.env.local` file:
+   - For local development, create a `.env.local` file in the **frontend** directory with the following:
 
-   ```env
-   NEXT_PUBLIC_API_URL=http://localhost:3001
-   ```
+     ```plaintext
+     NEXT_PUBLIC_API_URL=http://localhost:3001
+     ```
 
-   **For production builds**, create a `.env.production` file:
+   - For production builds, create a `.env.production` file in the **frontend** directory:
 
-   ```env
-   NEXT_PUBLIC_API_URL=https://production-server-url.com
-   ```
-
-
-2. **Set up the Backend:**
-
-   Create a `.env` file in `/backend/` and add the following environment variables:
-
-   ```env
-   SMTP_HOST=your-smtp-host                # e.g., smtp.gmail.com
-   SMTP_PORT=your-smtp-port                # e.g., 587 for TLS or 465 for SSL
-   [email protected]           # Your email address
-   SMTP_PASS=your-app-password              # Your app password for the email account
-   SENDER_EMAIL=your-sender-email           # Email address from which the emails will be sent
-   [email protected] # Default recipient email address
-   DEFAULT_RECEIVER_NAME=your-receiver-name     # Name of the default recipient
-   ```
+     ```plaintext
+     NEXT_PUBLIC_API_URL=https://production-server-url.com
+     ```
+
+3. **Backend Setup**:
+
+   - In the `/backend/` directory, create a `.env` file and add the following environment variables:
+
+     ```plaintext
+     SMTP_HOST=your-smtp-host                # e.g., smtp.gmail.com
+     SMTP_PORT=your-smtp-port                # e.g., 587 for TLS or 465 for SSL
+     [email protected]           # Your email address
+     SMTP_PASS=your-app-password              # App password for the email account
+     SENDER_EMAIL=your-sender-email           # Email address for outgoing emails
+     [email protected] # Default recipient email address
+     DEFAULT_RECEIVER_NAME=your-receiver-name     # Name of the default recipient
+     ```
+
+   - Replace placeholders with your actual values. **Note**: If using Gmail, you may need to enable "Less secure app access" or use an App Password to authenticate.
 
-   Make sure to replace the placeholders with your actual values.
+4. **Run the Application**:
 
-   **NOTE**
-   If you are using Gmail, you need to enable "Less secure app access" or use an App Password to authenticate.
+   Run both the frontend and backend together:
 
-   Once the `.env` file is added, run the server:
-
-3. **Run the application:**
-
    ```bash
    pnpm turbo dev
    ```
 
-### Running the Application
+## Accessing the Application
 
-After setting up the frontend and backend, you can access the application at:
+After setting up and running the application, you can access it at:
 
-http://localhost:3000
+[http://localhost:3000](http://localhost:3000)