Skip to content

Commit 674896a

Browse files
committed
First take on the Boilerplate
1 parent 0670a38 commit 674896a

File tree

8 files changed

+1714
-1
lines changed

8 files changed

+1714
-1
lines changed

.editorconfig

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
charset = utf-8
7+
trim_trailing_whitespace = false
8+
insert_final_newline = false

README.md

+84-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,84 @@
1-
# front-end-finals
1+
# Front-end final mockup-to-website project
2+
3+
Hey everyone!
4+
5+
This will be our final project in the front-end course, so let's make it a good one :)
6+
7+
First things first, let's get you set up. You will need the following…
8+
9+
## Dependencies
10+
11+
- Node.js
12+
- Figma
13+
- Figma Font Helper
14+
15+
## Install
16+
17+
We'll be using `node-sass` for our Sass compilation. Let's install that by doing:
18+
19+
1. `npm i`
20+
21+
## Getting started
22+
23+
### Source files
24+
25+
Have a look in the `source_materials` folder. There you'll find any fonts you need, images that are required by the design work.
26+
27+
2. Install any OTF/TTF fonts found in the `source_materials/fonts` folder in your system, so that you don't get bugged by Figma's Font replacement dialog box.
28+
29+
### Webroot
30+
31+
As with most setups, it's a good idea to isolate all the web-files in the `webroot` folder.
32+
Export all the images, fonts, HTML, JS, and CSS you use to this webroot folder (in the right subfolder of course!).
33+
34+
3. Create a `webroot/index.html` file.
35+
36+
### Sass
37+
38+
We'll be using the `scss` folder for all our Sass files.
39+
40+
4. Create a `scss/index.scss` file, that will act as our manifest Sass file.
41+
5. Build your CSS file once by running the `npm run scss` script.
42+
43+
All your Sass files will be output to the `webroot/css` folder.
44+
45+
### Linking up our styles
46+
47+
6. Link up the new `webroot/css/index.css` stylesheet in your `index.html`
48+
49+
## Development
50+
51+
You'll want to run the `scss:watch` task when you're developing this project.
52+
53+
## Marking & requirements
54+
55+
You have 5 days to convert the design work to a working single webpage. There's a lot to cover here in a week, and we don't expect you to have the entire website done in that time, but it would be great if you could.
56+
57+
So, what is expected then?
58+
59+
- **All the HTML**
60+
- Your HTML should be clean, accurate, and consistent.
61+
- Use the right elements for the right job.
62+
- Structure your HTML nicely.
63+
- Make sure your HTML is accessible.
64+
- Make sure your HTML is valid.
65+
- *Bonus points*: for progressively enhancing your HTML, e.g. using `<picture>` elements with multiple sources.
66+
- **As much Sass as you can**
67+
- Your Sass should use variables at a minimum, and be extended with mixins, functions, and abstract classes if you can.
68+
- Your Sass output should be orderly, and expected.
69+
- Keep your SCSS files clean
70+
- Add helpful comments to the difficult-to-understand parts.
71+
- You don't have to style everything within the time-frame. But we want to see completed components where possible.
72+
- **Images**
73+
- Are you using a `background-image` or an `<img>` in the HTML? Make sure it's for the right reasons.
74+
- Use the correct image format for each case
75+
- *Bonus points*: Compress your images
76+
- *Bonus points*: Use newer image formats such as WebP and AVIF, while still maintaining support for older formats.
77+
- **Fonts**
78+
- Link up the WOFF2 and WOFF formats to your CSS using as many `@font-face` at-rules as you need.
79+
- Use `local()` functions for locally-installed fonts.
80+
- *Bonus points*: Subset your fonts
81+
- **General**
82+
- Spelling
83+
- Testing
84+
- Don't feel pressure to complete the entire page, but rather try complete each component you start. **Leave out the bits that look too complex to make!**

0 commit comments

Comments
 (0)