web-basics-hello-world

A super-basic (and ugly!) web page to show off the basics for SoT hackfest (html, css, js...).

Following this readme should help to prepare you for a weekend of API hacking by familiarising you with the basics of git, running a simple python server, and playing around with some web technologies to get a basic webpage to display some data from a simple API.

Fork the repo and setup git

Up the top right of this page you will see a button labelled Fork. Clicking this will make a 'copy' of this repo (repository) for you. This copy will be yours to play with as you wish. You can make commits and branches as much as you want to without affecting the original repo. So do that and then continue on with this readme (which will be available in your forked copy).

So now that you have your very own copy of our repo we need to get the code onto your machine. If you are familiar with git you can clone it down however you wish.

If you are not familiar with git I recommend getting GitHub Desktop from here. Its fairly easy to use and is a good option for Windows and Mac users. (At some point though you should absolutely invest some time in learning how to use git via command line/terminal). Find the option to clone a repository in GitHub Desktop. It will ask for a url. On the GitHub page for your forked repo click the Clone or download button. Copy the URL from there into the URL field in GitHub Desktop and then clone the repo to your machine.

Wooo! If everything went smoothly you should now have a copy of the code on your machine.

Viewing the webpage in your browser

We recommend using the simple python server to serve up the webpage locally (You will need python installed https://www.python.org/ (If you have a Mac or a Linux machine you probably already have it installed)).

We need to use the command line to run the python server. Mac users can use Terminal, Windows users can use the Command Prompt, and Linux users should use whatever terminal app comes with their distro.

In your terminal/command line app navigate to the folder where index.html is located in your cloned repo (If you don't know what to do Windows users can look here, Linux and Mac users can look here). Then run the command python -m SimpleHTTPServer 8000. When that is running you can point your browser to http://localhost:8000 to see the page running.

After you have loaded the page in the browser go back and look at the python server's output in the terminal. You should see a bunch of GET requests for certain files (and maybe you'll see a cheeky 404 error when the browser tries to fetch the non-existant favicon.ico).

Note: SimpleHTTPServer will default to serving the index.html file at the root url

Note: If you are using python 3 then I think you will need to run python -m http.server 8000 instead.

Note: You might be able to just open the index.html page in a browser, but most browsers have security features that disable a bunch of things we might need when loading files locally. The python server will help us get around these security restrictions.

Working with web stuff

The repo you forked and cloned contains a web page that is pretty useless and gross to look at. There are a bunch of things you can fix up to make it better, and in doing so get to play with most of the core things that make web pages work.

Work on one thing at a time make a new commit for each thing you fix up. This way you have a history of changes that can help you if you (or someone else) makes a mistake and breaks something later.

To make a commit in GitHub desktop all you need to do is make some changes to the files in your local repo. The changes should appear in the GitHub Desktop app. Tick the files with changes that you want in the commit and enter the commit message details in the bottom right of the app. Click the commit button to make the commit! You can then sync the commits you have made on your local copy to your copy on github.com with the sync button up the top (which can also be used to pull down changes that have been made on the github.com copy if your local copy doesn't have them)

A good plain text editor to use for editing the files is Atom. You can get it here.

Note: Your browser will have a developer console you can use to debug things as you make edits. Chrome users can look here and Firefox users can look here. For everyone else you will have to google around...

Here are the things to fix up on the page:

Make the heading say something useful by editing the h1 tag in index.html (maybe something like 'hello world' yeah?)
Make the purple text purple by filling in the definition for the 'purple' css class in index.css (If you want to learn more here is a good guide for getting started with css. I recommend looking at the tutorial for css selectors as it comes in handy for interacting with the page via javascript)
Make the button print "Oh hi!" into the results-area div by binding a javascript function to the click action on the button element (hint: start with line 11 in index.js.)
Do something cool with the fetchRandomTriviaQuestion and displayQuestionAndAnswer functions (hint: maybe you can combine them and hook them up to the function that is called when the button is clicked?)

Completed example

If you want to you can checkout the branch called example to see what we did to finish the page. It might also help you if you get a bit stuck.

In GitHub Desktop you can click the branch button at the top to switch branches.

Bonus things to do if you're hungry for more

None of these ideas have examples or hints on where to write the code (so you'll have to figure out what to do on your own -- Google is your friend here).

Add some more information to the page. Write a couple of paragraphs about yourself. Add some stock photos of people riding horses. Add a link to your favourite youtube video... Play around with the html a bit.
Make the page less ugly. Write some css to make the layout nicer. Use a prettier font for all the text. Change the colours up. Experiment with what you can do.
Make the page display the current time (updated every second)
Build a number guessing game into the page. Rules:
- Computer picks random number between 1 and 100
- Player has 6 lives
- Player attempts to guess the number
- Game says 'too high', 'too low', or 'you win!'
- If the guess is incorrect: player looses a life and they get to guess again
- When lives run out the game is over
Customise the trivia game to be multi-choice instead of true or false (generate a new api url here: https://opentdb.com/api_config.php)
- Can extend this to allow the player to choose the trivia category before they begin the trivia game

knytcw01 / web-basics-hello-world Goto Github PK