From 335877289cfb8bb8510c41ba3ab67b3ade59d0b1 Mon Sep 17 00:00:00 2001
From: Erland A Syafiq <syafiqeas@gmail.com>
Date: Tue, 4 Jun 2024 14:43:13 -0400
Subject: [PATCH] Updated README

---
 README.md                 | 53 ++++++++++++++++++++++++++++++++++++++-
 docs/assets/.env.template |  4 +++
 2 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 docs/assets/.env.template

diff --git a/README.md b/README.md
index 5cb6f35..94fd92c 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ The VTMUNC web application serves as the online platform for the Virginia Tech M
 ## Technologies Used
 
 - **Frontend**: React.js, HTML+CSS+JS, and Vite
-- **Backend**: Node.js with Express.js framework
+- **Framework**: Next.js 
 - **Containerization**: Docker
 - **Continuous Integration/Continuous Deployment (CI/CD)**: GitHub Actions
 - **Deployment**: AWS EC2 instance running Ubuntu Linux, AWS DynamoDB for database and setup is done through bash scripts. 
@@ -18,8 +18,59 @@ The VTMUNC web application serves as the online platform for the Virginia Tech M
 
 ## Table Of Contents:
 
+- [🚀 Set Up] (#set-up)
 - [🌐 Deployment](docs/deployment.md)
 
+## 🚀 Set Up
+### Prerequisites
+
+- Ensure you have Node.js 20 installed. You can download it from [Node.js official website](https://nodejs.org/).
+- Ensure you have Git installed. You can download it from [Git official website](https://git-scm.com/).
+
+### Steps to Set Up the Project
+
+1. **Clone the Repository**
+
+   Open your terminal and run the following command to clone the repository:
+
+   ```bash
+   git clone https://github.com/erland-syafiq/vtmunc.git
+   ```
+
+2. **Change Directory to the Project Folder**
+
+   Navigate to the project directory:
+
+   ```bash
+   cd vtmunc/site
+   ```
+
+3. **Install Dependencies**
+
+   Run the following command to install all the necessary dependencies:
+
+   ```bash
+   npm install
+   ```
+
+4. **Copy .env Template**
+
+   Copy the `.env.template` file to a new `.env` file:
+
+   ```bash
+   cp ../docs/assets/env.template .env
+   ```
+
+   Open the `.env` file and fill in the necessary environment variables as per your project's requirements.
+
+5. **Start the Development Server**
+
+   Run the following command to start the development server:
+
+   ```bash
+   npm run dev
+   ```
+
 ## Contributing
 
 Contributions are welcome! If you'd like to contribute to the project, please fork the repository and submit a pull request.
diff --git a/docs/assets/.env.template b/docs/assets/.env.template
new file mode 100644
index 0000000..41407de
--- /dev/null
+++ b/docs/assets/.env.template
@@ -0,0 +1,4 @@
+AWS_DYNAMODB_ACCESS_KEY_ID=<access key>
+AWS_DYNAMODB_SECRET_ACCESS_KEY=<secret key>
+AWS_DEFAULT_REGION=<default region e.g: us-east-1>
+BACKEND_URL=<backend url e.g: localhost:3000>
\ No newline at end of file