From db8c3aacf5245d61b510b9f8da8bbc1ee58acacd Mon Sep 17 00:00:00 2001 From: Teanej <70343211+Teanej@users.noreply.github.com> Date: Sun, 27 Oct 2024 22:41:56 +0100 Subject: [PATCH] Improved Documentation Improved Documentation with slight visual changes that reduce the confusion in following of the documentation. --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b416219..796be8c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Zenica Bus Tracking Application -This application is designed for real-time tracking of buses in the city of Zenica, Bosnia and Herzegovina. +This application is designed for tracking buses in the city of Zenica, Bosnia and Herzegovina. **Deployment**: [Zenica Bus Tracking](https://kadjebus.zeforge.ba) @@ -32,13 +32,13 @@ Make sure you have the following installed: 2. **Frontend Setup**: - - For local development, create a `.env.local` file with the following: + - For local development, create a `.env.local` file in the **frontend** directory with the following: ```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: ```plaintext NEXT_PUBLIC_API_URL=https://production-server-url.com @@ -60,14 +60,16 @@ Make sure you have the following installed: - 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. -4. **Run the Server**: +4. **Run the Application**: + + Run both the frontend and backend together: ```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)