Home - kghandour/SE-2018-Helper GitHub Wiki

Welcome to the SE-T18 wiki! Hopefully this documentation will help.

Getting started

In order to get started, first follow the steps here https://github.com/omardoma/se2018

You DO NOT need to clone the other repos IF YOUR TUTORIAL REPO INCLUDES THEM

After installing all the programs, clone YOUR tutorial repo (or pull the changes) to a location that you know well and EASY to access (Ex. Desktop or Documents)

In order to get started you need to learn how to use CMDER (if you are on windows) OR the terminal if you are on ubuntu/mac.

  1. Start the database (Mongo) *If you are on windows, run mongod.exe from the folder (C:/Program files/Mongodb) *If you are on MAC/Ubuntu open the terminal then write mongod

If you get permission denied

write sudo mongod

If you get an error saying no folder called /data/db

  • If you are on windows go to your C drive, create a folder called data then inside of it create another folder called db
  • If you are on mac or ubuntu open the terminal then write mkdir /data/db if it gives you a permission denied error use sudo sudo mkdir /data/db
  1. Go to the folder where you cloned the repo, inside it you will find 2 folders, backend and frontend.
  2. Start the backend *If you are on windows, right click on the Backend folder and go to properties, you will find the path, copy it, then open CMDER then type cd and PASTE the path then press on enter *If you are on mac, right click on the Backend folder and select "get info" then you will find "Where" and the location, copy the location then open the terminal, and type cd and PASTE the path then press enter

This step is for all Operating systems

In the terminal or cmder type npm install All this does is it installs the node modules that we will use. They are like libraries that we need to get the code to work In the terminal or cmder type npm start This starts the backend server on the port 3000 ( localhost:3000 )

  1. Start the frontend
  • REPEAT The steps to go to the path of the front end in the terminal or CMDER
  • In the terminal or cmder type npm install The node modules are unique to the folder you are working on. So you need to type it once when setting up the front end and once when setting up the backend (And when we change the modules that we are using you will need to run npm install again)
  • In the terminal or cmder type ng serve This starts the front end server on the port 4200 (localhost:4200)
  1. Open the browser and type localhost:4200 and the website should open

P.S In order to start the backend or frontend again, you dont need npm install unless we tell you that we changed the modules that we use, so just type npm start to start the backend and ng serve to start the front end.

IF you get errors please google them, and if you couldn't find a solution, ask us on the group

I will try to write another page on other important instructions whenever possible.