chem120-game's Introduction

CHEM 120 E-Textbook

About

The project contains a game to quiz about the understanding of isomers in organic chemistry for students of CHEM 120 at DePauw University.

Setting up

Installation

Download the appropriate version of VSCode for your operating system.
(For MacOS) Install Homebrew and use it to install npm and nvm.
(For Window) Install nodejsand add it to path.
(For Linux) Install npm and nvm from terminal.

Add the Live Server extension to Visual Studio Code for debugging.
Set up the SSH key on your computer

Follow steps 1-4 of the instruction to Generate a new SSH key
Follow steps 1-9 of the instruction to Add a new SSH key to your GitHub account

Fork the repo to your GitHub account (click Fork on the top right of the screen)

Clone the repo to your local computer

 git clone [email protected]:<your-username>/chem120-game.git
 cd chem120-e-textbook
 git remote add upstream [email protected]:anhphuongdo34/chem120-game.git
 git remote set-url --push upstream DO_NOT_PUSH

For Jeff

To updates the changes made by students on your local computer

    git pull

To send your changes to GitHub so the students can use them

    git push

Contribution

(replace anything with the <> with your own content)

Before making any changes run git fetch upstream then git rebase upstream/master. The make changes in the code on the master branch
Create a new branch. If the changes associate with a specific issue, name the branch after the number of the issue.
```
 git checkout -b <new_branch_name>
```

Pull all the updates from upstream before commit new changes

 git stash
 git fetch upstream
 git rebase upstream/master

Add, commit, and push the changes
```
 git stash apply
```

Might need to resolve merge conflicts. Follow the instruction on the terminal.

    git add .
    git commit -m "<a short description of the changes>"
    git push origin <branch_name>

Make a Pull Request (PR) on GitHub.

Acknowledgement

This project uses ChemDoodle Web Components. The link to web.ChemDoodle.com and/or www.ChemDoodle.com.
Thank you Dr. Jeff Hansen, Professor of Chemistry and Biochemistry at DePauw University, for designing the game for the introductory Chemistry courses.

chem120-game's People