Prerequisites ✋

There are a few things you should download before starting.

Installation Guides

Cloning the repository 📩

The repository, or the folder with all the code, lives in a cloud-based service called GitHub that uses a version control system (vcs) named Git. To get a quick gist, GitHub is some-what similar to Google Drive in that they both revolve around hosting & storing shareable folders/files for collaboration.

Installing Git

First check if you have Git installed. Open up a terminal and type git --version. If you see a version number then you have Git installed 👍

Git is installed on my Windows (you might have a different version)

Git is installed on my Windows (you might have a different version)

If it says something along the lines of command not found (or some other kind of error), then go ahead and install Git by following the tutorial here. Make sure you follow the instructions that correspond to your Operating System (OS).

For an in-depth guide about using Git, read here:

Git

Downloading the source code

To clone (download) the code in GitHub, run this in your terminal

git clone <https://github.com/Hack-the-Future/mern-boilerplate.git>

After this, you should have a folder named mern-boilerplate/ with all the code! You can open this folder up in your favorite IDE or the recommended editor, vscode!

After opening the folder in vscode

After opening the folder in vscode

Installing packages

To run this project, you’ll need to install all the necessary packages/dependencies/libraries (used “interchangeably” but have different definitions). Learn all about node packages and how to install them here:

Node Packages