Home

Quick Start Guide

Here are the first steps to take to get started with using this template from scratch.

1. Download Yarn.

Download and install yarn by following steps from https://classic.yarnpkg.com/en/docs/install

2. Clone repository

Navigate to where you want to place the repository, and type: git clone https://github.com/Ray-F/mern-template.git <Project Name>

3. Set your new upstream

Type following commands: git remote rename origin upstream
git remote add <YOUR_GITHUB_URL>
git push origin master

4. Initialise your repository

Type yarn install in the root project directory, then run yarn run init (installs dependencies of client & server folders).

5. Start development server

Type yarn run start or yarn run dev to start your development server. Default hosts are ports 3000 for client, 9002 for server. To change the server port, rename .env.example (in server folder) to .env