PDA-Website

Official PDA-MIT Website Building Repo Do Star the Repo on top right

Contribution Guidelines 💻

Step 1: Fork the Repository

Click on to fork this repsository

---

Step 2: Cloning Repository using Git

git clone https://github.com/'<your-github-username>'/PDA-Website.git

---

Step 3: Change directory to PDA-Website

cd PDA-Website

---

Step 4: Add reference to the original repository

git remote add upstream https://github.com/pda-mit/PDA-Website.git

---

Creating a New Branch 🛠

1️⃣ Always keep updating your master branch with the main repository by running the following command on the local master branch. Here the default master branch is the main branch.

git pull upstream main

2️⃣ Always create a new branch before making any changes. Never ever make any changes directly on the master branch. To create a new branch,

git checkout -b '<new-branch-name>'

---

Setup Guidelines ⚙️

Installation using NPM and MongoDB

• Download Node Js and npm(Node package manager) (when you install Node, npm also gets installed by default)

• Mongo DB compass which is free and a great software in order to work with MongoDB applications. Download Mongo DB compass

• Run this command to install all dependencies for the project.

npm install

• Testing : Run this command on your terminal/ bash to start the Mongo server on port 27017(default).

mongod

---

Run on Localhost 👨‍💻

• Run this command to start the project.

node app.js

• Open link to view the website in your browser window if it doesn't open automatically.

http://localhost:3000/

---

Commiting the changes and Making Pull Request 🚀

1️⃣ After Editing files in the new branch Stage your changes

git add .

2️⃣ Commit your changes

git commit -m '<your_commit_message>'

3️⃣ Check for Status to be sure everything is added

git status

4️⃣ Check for your remote

git remote -v

5️⃣ Push changes to remote

• Note : During this stage, a sign in pop-up will appear in GitHub requesting for OAuth. Either Sign in using OAuth browser session or create a Personal Access Token to login.

git push -u origin '<your_branch_name>'

6️⃣ Open a Pull Request

---