Welcome, Developer! Before you can begin restructuring the repository, you need to ensure your local environment—your "workshop"—is equipped with the necessary tools. This guide will walk you through setting up and verifying each prerequisite. Upon completion, you will have a functional local clone of the GitHub repository, ready for the structural changes.
📋 Prerequisite 1: GitHub Repository Access
Before any work can begin, you must have access to the project's code library.
Technical Steps to Action & Verify:
- Obtain the Repository URL: This is the unique web address for the project's GitHub repository.
- Verify Access: Open the URL in your web browser. If the repository is private, you must be logged into a GitHub account that has been granted access as a collaborator.
Non-Technical Explainer: This is like having the correct address and a key to the library. You need to be able to find it and unlock the door before you can start organising the books and scrolls inside.
📋 Prerequisite 2: Git Installation and Configuration
Git is the version control system that tracks every change made to the code. It's essential for cloning the repository and saving your progress.
Technical Steps to Action & Verify:
- Install Git: If you don't have Git installed, you will need to download it from its official website.
- Check the Installation: Open your terminal and run the following command. It should return a version number.
- Configure Git: Git needs to know who you are. Run the following commands in your terminal with your details.
Non-Technical Explainer: Git is a magical ledger that records every change made to the project. Installing it gives you this tool. Configuring it is like signing your name in the ledger, so every change you make is attributed to you.
📋 Prerequisite 3: Node.js and npm Installation
Node.js is the runtime environment that will power our backend, and npm is the package manager that fetches the tools and dependencies we need.
Technical Steps to Action & Verify:
- Install Node.js and npm: Download the LTS (Long-Term Support) version from the official Node.js website. Npm is included with the Node.js installation.
- Check the Installation: Open a new terminal window and run these two commands separately. Each should return a version number.
Non-Technical Explainer: Think of the `backend/` as an "engine room". Node.js is the main engine that provides the power. npm is the workshop's delivery service; it fetches all the specific tools and parts (like Express.js) that you'll need to build and run the backend machinery.
✅ Final Verification: Clone the Repository
With all prerequisites installed, the final step is to create a local copy (a "clone") of the repository on your computer. This action confirms that all your tools are working together correctly.
Technical Steps to Action:
- Open Your Terminal and navigate to a directory where you want to store the project.
- Clone the Project: Run the `git clone` command with the repository URL.
Non-Technical Explainer: This is the moment you use your key (GitHub access) and your special tools (Git) to create a perfect, personal copy of the entire library on your own desk. Now you can start organising it without affecting the original master copy until you are ready to share your changes.