Showing posts with label portfolio. Show all posts
Showing posts with label portfolio. Show all posts

Thursday, 17 September 2015

Week 8: SASS how-to

Initial set-up

  1. Download the source files from Bootstrap 
  2. Unzip them into the folder where you will be using them (in our case, I have set-up a 'SASS' folder in our git repo)
  3. Follow the instructions on tooling set-up on Bootstrap (repeated below)
    1. Download and install Node.js
    2. Using the command line (Terminal, iTerm, Powershell, what-have-you), install Grunt with npm install -g grunt-cli
    3. After a quick refresher in command line, navigate to the Bootstrap folder that you unzipped (for us: 'SASS' as above).  OK, so now you're using the command line and you're in the Bootstrap folder.  If you type ls it should look similar to this:

    4. Install the local dependencies listed in package.json by running npm install
    5. Next up is Ruby.  If you are on a mac, you should have it already installed but can check by typing ruby -v into the command line.  If you need to download or update there is info here and here.  But, if you need to install on Windows, we ran into a few problems and used this tutorial from Forward HQ to sort it out.
    6. Almost there! Two-parter for Bundler: 1) install in the command line by running gem install bundler and then 2) run bundle (for all the Ruby dependencies you will need).
  4. Last step, install SCSS Lint by running gem install scss_lint
Phew, you still with me?  You may (or hopefully not) have any errors.  You may need to prefix the command line with sudo (I know, I know, lots of people say you shouldn't), or might get other random errors (google is your friend), but hopefully you have the things installed.  Now for the fun part :)

Using SASS

In your Bootstrap folder (for our team 'SASS') is a folder called 'scss' which is filled with many, many .scss files.  Being Bootstrap, it is all fairly logically named so it shouldn't be too hard to find any CSS you need to change.  '_variables.scss' has all the colours and typography (amongst other things), etc, etc. Have a look at the SASS documentation for how to use variables, nesting, other syntaxy-things.

Once you've changed the things you need to, how do you get it to be a CSS (and JS) file to use on the website?  Back to the command line!

To compile the CSS/JS files:
  1. Using command line, navigate to the bootstrap folder we were working in before.  You may still be there :)  (I'm a broken record but "For our team it is the 'SASS' folder")
  2. run grunt dist and fingers crossed, 0 errors!
For our purposes, that's about it but there is more info on grunt commands in the Bootstrap documentation.

Notes for team

  • No need to copy/paste files or folders, the CSS and JS import links are now up to date!
  • Remember: sync git, make changes, sync git
  • The Bootstrap 4 documentation has lots of great info, start with Layout, Content, Components
  • Bootstrap also has a slack channel - a great place to go for help!


Sunday, 6 September 2015

Portfolio overview Weeks 1-7

Empathise

  • research into target audience (internet and user interview)

Define

  • Trove API limitations
  • Part A project documentation

Ideate

  • Technologies
    • use of HTML imports
    • Javascript and jQuery to make HTML imports work and interactive
    • familiarity with node.js, npm, bower to install jquery, bootstrap and bootstrap themes
    • (future - Compass and SASS)

Prototype

  • (future - paper prototype this week)
  • (future - prototype header/nav with users)

Test

  • Not yet

Week 7: HTML imports and setting up CSS

Part of my tasks for this week included looking into web components or HTML imports for our header and starting on our CSS styles.

Header

The idea behind using web component or HTML import for our header was to reduce the amount of code we needed to write and maintain across the site.  Instead of creating the header on one page, copying it to other pages, and then editing every page when there was an update, I decided to look into alternatives.  I had a look at web components (I have used polymer in the past) but also something a bit simpler with HTML imports.

Requirements

  • header and nav consistent across every page
  • 'active' class needs to be applied to nav of current page
  • need a log in/log out view
As most of content is static for this section, I decided to go with HTML imports as I didn't need to create a template for content reuse.  I had a look at the following tutorials: treehouse, html5rocks, sitepoint, webcomponents.org.

Step 1: Create the header 

Create a separate HTML file for the header.  No need for head or body tags, just the parts that relate to the header.  I'll go into more detail about what I put into the header when I talk about styles. I saved this as header.html


Step 2: Import HTML

Import the HTML file into the head of your index page (or page you will use it on)


Step 3: Use the HTML import on your page

This step is quite varied depending on what you want to do and how.  I did this by creating a header section in the body, and then using javascript to target the header and insert header.html. I also added in a line of jQuery to target a particular child in the nav to add the active class.

I haven't added in any script for the login yet but feel it will be easy enough to do once it is ready.

The other thing to note is the HTML imports need to run on a local server when testing (you can't just open the HTML file in your browser).  I found some really good instructions at superuser (see answer by Jake Gould) and installed MAMP.

Styles

Last week at our team meeting, we briefly discussed styles and using material design as a template. I think it is a good idea but am not overly attached if we go in another direction.

I found a version of material design theme for bootstrap which I thought would be good for our project and went down the rabbit hole of installing things.

Material Design for bootstrap http://fezvrasta.github.io/bootstrap-material-design/#getting-started
and demo http://fezvrasta.github.io/bootstrap-material-design/bootstrap-elements.html

I used bower but also had to install Node.js and npm (good overview here), XCode.  I then installed bootstrap and finally material design for bootstrap (and their snackbar).

I'm looking to using SASS for our CSS variables and also installed Compass but haven't got any further on that yet.

I used the material design nav styles straight out of the box.  I'm sure we will change colours and other elements but for the moment the structure is there.



Friday, 4 September 2015

Week 6: Progress and Part A concept document

The last week or so has been spent concentrating on part A, what was needed for the pitch and the document.  While other team members concentrated on the presentation or further technical or design research, I spent this week considering the project documentaiton and writing up the part A document.

As I read through the document requirements, it seemed to partly reflect project documentation I had previously worked on in my job.  Thinking about how the major project is meant to feed into our portfolio assessment at the end of semester, I had previously only considered the technical elements I could include.  It occurred to me that project management and documentation were also important skills I could gain from this project and add to my portfolio.

While it might have been easier to just answer the couple of dot points required for the document, I thought it would be more useful to use some of my existing project documentation skills and create a more comprehensive document.  My approach was to look at the assessment requirements, look at what I would include for a real project proposal including supporting documentation and then cut or add what we needed for the project.

Matching assessment requirements with project documentation


Document requirements Project documentation
A survey of relevant background material – which published works does the design build on and how these are related. Rationale for project.
Why are we doing this? What problem are we solving? What does the research say?
Consideration of the intended audience and the experience you want them to have – who are your intended audience, how and in what context do you expect them to interact with your work, and what do you want them to experience as a result. Outcomes, benefits and impacts.
What are the users needs and how will they met? What personal/student benefits are there (learning technical skills).
Project plan including scope for implementation Scope
What is the level of detail? What is in scope and out of scope. Time is fixed, scope is flexible.
Breakdown of milestones with expected tasks & completion times for delivering the project Task Analysis
Could include: Deliverable, Effort, [Must, Should, Could, Won’t], Status, Notes.

This might be too much detail, minimum is item, week, and notes.
Breakdown of who in the team will be responsible for tasks and how the workload will be spread across the team. Proposed staffing
Team members including roles and responsibilities
Issues you think that you may encounter in the implementation of your project and suggestions for how to overcome them. Risk Analysis
List risk, impact (1-5), likelihood of risk (1-5), overall risk score(1-25) and mitigation.
This might be too much detail, minimum is risk and mitigation.
Response to feedback received in presentation Include in other areas as needed.


Other project documentation

Other items normally included in project proposals and documentation that may or may not be relevent to this project.

Item Rationale Include in Part A
Success criteria
Could be as simple as a finished product or include learning outcomes
Is a requirement of Part B documentation, will include then. No
Assumptions and constraints
What box are we working inside (fixed deadline of assessment and semester deadlines).
It is assumed that… (through a combination of formal teaching and self-directed learning that team members will be to technically deliver this project).
Probably overkill for our assessment, won't include. No
Proposed costs
Should be nil, expectation of software that each team members will have (mostly freeware)
Not neccessary for this project No
Communication plan
Internal only as there is no real client/audience stakeholders. Include github, drive, plus, facebook etc.
Could include tutors, brief (client)??
Will include internal only.  Had listed in in team charter (informal) Yes
Stakeholder analysis.
Include audience in this. What other stakeholders do we have? Could include audience, team members roles, tutors/teaching staff, team members as students (what will i get out of this course - skills). Present as stakeholder interest, expectations, and strategy.

More detail than needed for this project.
Combine audience with outcomes, benfits and impacts.
Incorporated in other section
Proposed deliverables 
Specific items we will achieve by end of semester

Proposed time frame 
Time frame for deliverables (milestones)
Not enough items/too early in the project to have separate task analysis, proposed deliverables and proposed time frame.  Combine into one section. Incorporated in other section