Skip to content

Commit ed6a661

Browse files
committed
Updating the readme to include tasks
1 parent 335a328 commit ed6a661

File tree

1 file changed

+100
-10
lines changed

1 file changed

+100
-10
lines changed

README.md

+100-10
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,107 @@
11
# HTML Portfolio
22

3-
Welcome to the HTML Portfolio Project! For this project, you'll be creating a personal web page to show off your work. We will test your HTML knowledge and then it will be up to you to use CSS to style your own page and make it unique.
3+
You'll create a personal web page to show off your work. We will test your HTML knowledge, and then it will be up to you to use CSS to style your own page and make it unique.
44

5-
Please follow the instructions below to complete the project. Be sure to run tests to make sure your tests are passing before submitting your code.
5+
## What You'll Build
66

7-
## Getting Started
7+
The end result will be a portfolio that you can deploy publicly! Here's a sample of what this could look like:
88

9-
To get started with this project, head over to the [HTML Portfolio](#) project on Code School, and begin!
9+
![Sample Portfolio](http://courseware.codeschool.com.s3.amazonaws.com/projects/build-a-portfolio-using-html-and-css.png)
1010

11-
For further instructions on how to get the app setup locally, visit our wiki:
11+
## What You'll Learn
1212

13-
1. [Welcome](https://github.com/codeschool/project-html-portfolio/wiki)
14-
2. [Prerequisites](https://github.com/codeschool/project-html-portfolio/wiki/Prerequisites)
15-
3. [Setup](https://github.com/codeschool/project-html-portfolio/wiki/Setup)
16-
4. [What we'll build](https://github.com/codeschool/project-html-portfolio/wiki/What-we'll-build)
17-
5. [Step by step](https://github.com/codeschool/project-html-portfolio/wiki/Step-by-step)
13+
We'll dive into a number of basic HTML concepts, including:
14+
15+
* Creating an HTML page
16+
* Using classes to organize your page and tie in styles
17+
* Using headings to denote importance
18+
* Adding text using paragraphs
19+
* Creating links so users can contact you
20+
21+
## What You'll Need
22+
23+
You'll need a GitHub account, Git installed locally, and a text editor to edit HTML. We recommend using GitHub's [Atom Editor](https://atom.io/), which is free and very powerful. The [Brackets](http://brackets.io/) editor is another great tool.
24+
25+
## Live Demo
26+
27+
Here is a [working version of this project](https://codeschool-project-demos.github.io/HTMLPortfolioProject/), and now it is your job to out-do our version of this project by customizing your portfolio even further and adding more CSS rules, etc. We can't wait to see what you come up with!
28+
29+
## Setup
30+
31+
Once you have cloned the forked repository, go into the directory containing the project and look for the `/src` directory. This is the directory where you will be making changes when you start following the step-by-step instructions. You can simply open those files in a text editor and get started.
32+
33+
You can always open the index.html file directly in your browser and work through the tasks below. You can also head over to the [Node.js](https://nodejs.org) website and follow the instructions to install Node on your machine. Once you have Node installed, open your command line and follow these instructions:
34+
35+
```
36+
cd HTMLPortfolioProject
37+
npm install
38+
npm start
39+
```
40+
41+
Running `npm start` should open a browser window pointing to `http://localhost:3000`. Now once you make changes to the files under the `/src` directory, your browser will refresh automatically, displaying the newest changes made to the files. This will save you the round trip of saving files and clicking refresh on your browser.
42+
43+
## Tasks
44+
45+
Complete the following tasks to finish this project.
46+
47+
48+
### Create the Page Header
49+
50+
At the top of our page, we'll want to create an element with a class of `header` for us to add some information about ourselves. MENU
51+
52+
### Header Text
53+
54+
Inside of our `.header` element, create an `h1` tag with your name in it. This is your portfolio, so it makes sense for your name to have the most prominence. MENU
55+
56+
### Job Title
57+
58+
Also inside the `.header` element, add a `h2` tag with a job title (ie. "software developer", or "web designer", or "maker of things", etc). MENU
59+
60+
### The Tagline Element
61+
62+
Next, create a new element that has a CSS class called `tagline`. In this element you'll be giving a little more information about yourself. MENU
63+
64+
### A Little About You
65+
66+
Inside the `.tagline` element, create a `h3` tag inviting the visitor to learn more about you (ie. "Learn More About Me", or "Here's What I Do", etc). Also add an introductory paragraph with more information about yourself, including what things you're passionate about, programming languages you enjoy writing in, etc. MENU
67+
68+
### The Skills Element
69+
70+
Next, we'll create a place to list out our current skills by creating an element with a class of `skills`. In here we'll be listing out what we already know. MENU
71+
72+
### Skills Content
73+
74+
Inside the `.skills` element, create a `h3` tag inviting the user to learn more about your skills (ie. "my skills"). Also add a paragraph tag describing your skills (ie. "I enjoy writing front-end code with these technologies"). MENU
75+
76+
### List of Skills
77+
78+
Inside the `.skills` element, create a new `ul` which will be a list of of your skills. In here, add 3 skills you currently possess. `HTML` must be one of these skills. MENU
79+
80+
### The Contact Element
81+
82+
The last section of our page will give people a way to contact us. Create a wrapper element for this area and give it a class of `contact`. MENU
83+
84+
### Contact Copy
85+
86+
Inside the `.contact` element, create a `h3` tag inviting the user to contact you (ie. "contact me", or "drop me a line"). Also add a paragraph tag describing how people can contact you. MENU
87+
88+
### Contact Link
89+
90+
Lastly, we just need a way for people to get in touch with us! In the paragraph you created, add an anchor tag (an `<a>` element) pointing people to a place where they can get more information about you (ie. Twitter, LinkedIn, Github, etc).
91+
92+
93+
## Next Steps
94+
95+
Now that we have a working portfolio site, the next (optional) step is to style it. If you want to learn how to style this one with Bootstrap, head over to the [Build a Portfolio Using Bootstrap)(/projects/build-a-portfolio-using-twitter-bootstrap) project.
96+
97+
If you’d rather style it on your own, now’s an excellent chance to add a stylesheet to this project and use those CSS skills!
98+
99+
## Deploying
100+
101+
Putting this site up on GitHub pages is a bit different than some other projects because the code is all in the `/src` directory. There’s a nifty way to push this directory to a GitHub branch, which allows you to use GitHub pages with it! Try running this Git command for this project:
102+
103+
```
104+
git subtree push --prefix src origin gh-pages
105+
```
106+
107+
This will push the `src` folder up to GitHub on the `gh-pages` branch. After that, you should be able to open up `http://username.github.io/HTMLPortfolioProject`, where `username` is your GitHub username.

0 commit comments

Comments
 (0)