HandyMan App - college project

Project Setup

1. Install Visual Studio Code
2. Install Node.js (This installation includes npm and chocolatey)
3. Validate installations see below
4. Clone this repository onto your PC
5. Inside the local repository root folder, run npm install. This will install the required dependencies of the project.
6. The project is ready to use

Run project

In the project root folder, run command npm run dev

Validate Installations

1. Open Command Prompt (Windows) or Terminal (Mac)
2. To validate Node.js, run command node --version
3. To validate npm, run command npm --version

Git process

1. For this process you need your local environement properly set up If not see Project Setup step.
2. Make sure you have git install to validate open terminal or command promt and type git --version if not please install [git] (https://git-scm.com/download). For windows you can download gitbash. It is a linux terminal that you can run on windows.
3. Now open Open Command Prompt (Windows) or Terminal (Mac) and change directory to your project. You should be inside your project directory.
4. Check your branch status by typing git status. You should see messaging saying that your on mastser branch and it is upto date.
5. Before you start your work create a new beanch by running git checkout -b <branch name>(for example git checkout -b feature/login ).
6. Make your code changes and make sure everything is working as expected.
7. Run git status. You should see files that you have changed.
8. Run git add . This will prepare you files to be commited.
9. Run git commit -m '<message>'. This will commit chnages to your local branch.(e.g. git commit -m "login page added").
10. Run git push. you will see te msessage on terminal git push --set-upstream origin feature/add-git-process. Simply copy that line and paste it again. Now you have pushed all the changes on Git hub.
11. Go to github and you should see New pull request button. Click on it and select your branch in compare dropdown. Click Create pull request.
12. Once Pull request is created you can assign to the team members to review from reviewers dropdown on github. If you are in your local branch feature/login and you want to switch to an existing branch or a master branch Run git checkout <branch>. (e.g. git checkout features/readme).

Contributors

ibkucher, Nparekh90, AbbyNode, emmajsl, BillyLee96312, Helia and Imitaz