diff --git a/README.md b/README.md
index e5457ed..93c86b4 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,7 @@ https://github.com/user-attachments/assets/9fbd2c41-09e1-4843-88d5-5ee2e64de43d
1. [Featured In](#featured-in)
2. [About Us](#about-us)
3. [Tech Stack](#tech-stack)
-4. [Get Started](#get-started)
+4. [Installation Instructions](#installation-instructions)
5. [Contributing](#contributing)
6. [Website Preview](#website-preview)
7. [Our Contributors](#our-contributors)
@@ -92,60 +92,103 @@ It is an online platform which enables you to get information about your vintage
-##
Get Started
- -### Setup and Installation - -To contribute to the Retro repository, follow these steps:
- -1. **Fork the Repository:** - Click on the "Fork" button on the repository's GitHub page to create a copy of the repository in your GitHub account. - -2. **Clone the repository:** - Clone the forked repository to your local machine using the following command in your terminal. - ```bash - git clone https://github.com/Installation Instructions
+ +Follow the steps below to set up and run the project locally: + +## 1. Clone the Repository +Clone the repository to your local machine using the following command: +```bash +git clone https://github.com/Anjaliavv51/Retro.git +``` + +## 2. Run the Frontend +The frontend is a static application. To run it: +1. Navigate to the frontend folder (if applicable) or locate the `index.html` file in the project root. +2. Open the `index.html` file in your browser. + + +## 3. Run the Backend + +### 1. Prerequisites +Before running the backend, ensure the following software is installed on your machine: +- **Node.js**: Install a compatible version for the project. [Download Node.js](https://nodejs.org/) +- **Git**: Version control system. [Download Git](https://git-scm.com/) +- **pnpm**: A fast, disk-efficient Node.js package manager. + + Install pnpm globally using npm: + ```bash + npm install -g pnpm + ``` + + Verify the installation by checking the version: + ```bash + pnpm --version + ``` + + +### 2. Navigate to Backend +Change your directory to the backend folder: +```bash +cd backend +``` + + +### 3. Create a `.env` File +In the `backend` folder, create a `.env` file to store environment variables: +```bash +touch .env +``` + + +### 4. Configure Environment Variables +Add the following variables to the `.env` file: +```env +PORT=3000 +MONGODB_URL=ADD YOUR MONGODB ATLAS DRIVER CONNECTION STRING +SECRET=INPUT YOUR SECRET KEY. SAMPLE: MYSECRET123 +``` + +### 5. MongoDB URL Setup +To get the MongoDB URL, follow these steps: +1. **Login to MongoDB Atlas**: [MongoDB Atlas Login](https://account.mongodb.com/account/login?nds=true) +2. **Create a New Project**: + - In your MongoDB Atlas account, create a new project. +3. **Create a New Cluster**: + - Under the newly created project, create a new cluster. +4. **Create a New Database**: + - Inside the cluster, create a new database named `retro_db`. +5. **Get the Connection String**: + - Click on the cluster, select **Connect**, and retrieve the connection string. + - Replace `Contributing
+If you find a bug, have a feature request, or would like to contribute in any way, feel free to open an issue or submit a pull request. Whether you're enhancing the technical documentaion or adding a new feature, your efforts are valued, and together we can make this project even better. Thank you for considering contributing to [Retro](https://github.com/Anjaliavv51/Retro)! -We appreciate your feedback! Our goal is to make contribution to this project as easy and transparent as possible. Whether you're interested in:
To get started with contributing, please follow the steps outlined in the Contributing.md.
+