README.md

Start Here

This repository is to help our team learn how to use git and github. Here is a link to read more about git and github

Steps for Git

1. Install git and/or github desktop on your device.
   • git download
   • github desktop
2. Clone the repository. This makes a copy of the files that you can edit on your machine.
   • How to clone a repository (there are many different ways to do this)
3. Check if an issue is assigned to you.
4. Create a branch titled something meaningful, like"{Issue Number}-{descriptor of issue}"
   • Example: Say I was assigned issue 123 that asked to implement a scroll bar. I could name my branch "123-scroll-bar" to show what I was working on.
   • Sometimes, you will need to work on something that doesn't have an issue opened for it. I recommend opening a new issue that describes what you are planning to work on and name the branch as described above. Otherwise, still try to give a meaningful name to your branch (ex. "automated-tests").
   • Names like "ashley-branch" or "new-stuff" are not helpful to someone reviewing the repository.
5. On your new branch, implement your changes.
6. Commit often. Commit early.

   • About commits

   • Overview of command line commits

   • On github, a commit with two messages will show the first message as a preview and the second message when the commit is clicked. Please make the first message a brief description of the commit and the second message a more detailed description of what was changed

   • Example: Command Line Commit

     git commit -m "Changed log file output" -m "Now when unit test fails, the error message {error_msg} is added to the log file. Changes made in files Logger.ts and app.component.ts
     

7. Push your changes to remote repository.
   • git push
8. Create a pull request to merge changes to master branch.
   • About pull requests
   • Creating a pull request
   • Link pull request with the issue it resolves with "fixes #{issue number}" somewhere in the pull request
   • Example:
9. Assign someone to review your pull request.
10. Review the pull requests that are assigned to you.
    • Accept merge if changes resolve the issue.
    • Comment on the pull request if more changes are necessary.
11. Resolve merge conflicts.
    • Resolving conflicts on Github
    • Resolving conflicts using command line
    • You can also resolve them using your IDE/editor
12. Pull changed from the remote to your machine
    • git pull
    • Updates the files on your device if someone else has pushed changed to the remote repository.
13. Profit!!!

Steps for Hello World

We are using the Hello World Tutorial from Angular.dev

Tools Needed

1. IDE, like VS code

2. npm installed

3. Node.js installed

   • check that your version of node is meets the requirements for angular

4. Install Angular CLI

   • Run:

   npm install -g @angular/cli.
   

   • You can use any version of node and angular for this tutorial as long as it works. This isn't production code.

Steps to Run app

1. Navigate to this repo's directory in your terminal
   • It should already be there if you open the terminal in VS code from the folder
2. Run

   npm install
   

3. Run

   ng serve
   

4. Go to http://localhost:4200/ in your browser to see the webpage.

Note: If you get warnings during these steps, and npm audit fix does not fix them, don't worry. It will probably still run.