https://github.com/yining1023/ml4w-homework
https://github.com/yining1023/ml4w-homework
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/yining1023/ml4w-homework
- Owner: yining1023
- Created: 2019-03-28T00:52:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-31T18:10:05.000Z (over 6 years ago)
- Last Synced: 2025-03-14T10:11:47.985Z (7 months ago)
- Language: HTML
- Size: 15.5 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ml4w-homework
## See Demos live:
- [Week1](https://yining1023.github.io/ml4w-homework/week1/) Image Classifier on Webcam
## How to push code to a Github Repo and host sketch on Github
Before we get started, you can also work on top of this [p5 sketch](https://editor.p5js.org/ml5/sketches/rJ-C5AQ5X) in p5 Web Editor for week 1. Since p5 Web Editor already hosts the sketch for you online, you don't need to host your sketch on Github. If you want to learn how to host your sketch on Github, please continue reading. :)
Here is a video about [How to host p5 sketch on github pages](https://youtu.be/8HPYsDTk17A).
Here is a step by step guide about how to push code to a Github Repo and host sketch on Github
1. Login to Github: https://github.com, go to https://github.com/YOUR_USERNAME.
2. Click on the "+" on the top-right corner, dropdown - click on "New repository".
3. Fill in the "Repository name", "Description", check the checkbox "Initialize this repository with a README", click on the "Create repository" button.
4. You will see a new repository page.
5. Put your `sketch.js` and `index.html` file into a folder called `week1`, and drag the folder into the new repository page.
6. Under the "Commit changes", type in commit message, like "added week 1", click on . "Commit changes" button.
7. You should be able to see a new folder `week1` listed on the repository page.
8. Go to right top corner, click on "Settings", you will be on https://github.com/YOUR_USERNAME/ml4w-homework/settings
9. Scroll down the page, find "Github Pages", click on "Source - None" dropdown, select "master branch".
10. After 2 mins, refresh the page, you should be able to see a green bar saying: "Your site is published at https://YOUR_USERNAME.github.io/ml4w-homwork.
11. Go to that link: https://YOUR_USERNAME.github.io/ml4w-homwork, you will see the following page.
12. Add `/week1` at the end of the url(https://YOUR_USERNAME.github.io/ml4w-homwork/week1), you will see your week1 demo.
13. Go to this link: https://github.com/yining1023/machine-learning-for-the-web/wiki/Week-1--2019-Spring, click on the "Edit" button on the top-right corner.
14. Add your name, homework link and description at the end, click on "Save" button.
15. That's it!! You should be able to see your homework link on the page: https://github.com/YOUR_USERNAME/machine-learning-for-the-web/wiki/Week-1--2019-Spring.
## How to update your code and push it to Github
If you would like to update your code, you can follow these steps:
1. Make a new folder on your Desktop called "ml", open your terminal.
2. Type `cd `(cd and a space), drag the "ml" folder into the terminal window. You will see your command changes to: `cd /Users/YOUR_NAME/Desktop/ml`
3. Hit `enter` or `return` on your keyboard. You will see in your terminal, you are at this path: `~/Desktop/ml`
4. Go to the ml4w-homework github repo we created before: https://github.com/YOUR_USERNAME/ml4w-homework, click on the green "Clone or download" button, copy the link highlighted in green: https://github.com/YOUR_USERNAME/ml4w-homework.
5. In your terminal, type in `git clone `, with the link we just copied(git clone https://github.com/YOUR_USERNAME/ml4w-homework1.git). Hit enter.
6. In your terminal, type in `cd ml4w-homework`, hit enter.
7. Go to the Desktop, open `ml` folder, open the `ml4w-homework` folder with your code editor. Edit the code, make some changes.
8. In the terminal, type in `python -m SimpleHTTPServer` or `python3 -m http.server` if you are using python 3. The terminal will say "Serving HTTP on 0.0.0.0 port 8000 ...".
9. Go to `localhost:8000/week1` in your browser, you will see your example.
10. You can change some code, refresh the web page to see the changes.
11. After you are happy with the result, go back to terminal, hit "control + c" key, to quit the server,
12. In the terminal, type `git status` to view your changes
13. In the terminal, type `git add .` to add all your changes
14. In the terminal, type `git commit -m "updated week1"` to add a commit message.
15. In the terminal, type `git push origin master` to push the changes to `master` branch.
16. Go to your github repo page: https://github.com/YOUR_USERNAME/ml4w-homework, you will see week1 is updated.
17. After 5 mins, your public sketch (https://YOUR_USERNAME.github.io/ml4w-homwork/week1) will be updated with your new change too.
