Skip to content

Code Institute and Trust in SODA collaborative January 2022 Hackathon

Notifications You must be signed in to change notification settings

lexach91/team-5-january-hackathon

Repository files navigation

Table of Contents


Responsivity

About Clover

Clover was created with users working from home in mind. With the global pandemic of the previous two years, things have shifted dramatically within work places. We want to assist folks who are having trouble working from home. The website has a lot of resources for people to look over in order to get relevant information. It's critical that people realize they're not fighting alone in whatever battle they're now engaged in. We hope to generate participation from you and look forward to hearing from you.

Heres a link to the website.


UX

User Stories

  • As a user, I would like to be able to browse the website.
  • As a user, I would like to know more about Clover.
  • As a user, I would like to sign up for a newsletter.
  • As a user, I would like to find Clover on other websites.
  • As a user, I would like to be able to find links to useful apps and other informative sites.
  • As a user, it is important I understand how to use the website.

(sub headings, UX planes, strategy, scope, structure, skeleton, surface)

Back to the top of page


Features

Existing Features

  • Home page with general information about Clover.
  • Main image with links to the rest of the site.
  • 4 internal pages on different topics.
  • sign up form for Newsletter.

Features left to implement

We would have to loved a social media section with a place for home working people to communicate with each other.

Back to the top of page


Technologies Used

Back to the top of page


Testing

Responsive Testing

This website was built as a desktop first solution with adjustments then made for smaller devices.

Below is a table we used to keep track of adjustments and to test adjustments made.

  • A = Adjusted
  • n/a = Not affected
  • X = Not included
Features - Widths 1570px 1350px 1050px 970px 768px 485px
Navigation bar A
Home page A
Main images A
About
Articles A A A A
Stress page
Exercise page
Concentration page
Sleep page

Color Contrast Testing

The color contrasts were tested on Contrast Grid.
Color Contrast

Validator Testing

HTML5

The HTML was tested using the W3C validator. To do this we put the URL of each webpage into the validator.
We recieved some errors due to imported files, but none on the site itself.

CSS3

The CSS was tested using the W3C validator. We did a direct input for our CSS file.
The test did test did not contain any Errors.

JSHint

The JavaScript was tested using the JSHint. We did a direct input for our JS file. The file was tested without warnings.

Lighthouse

To test our websites performance, accessibility, best practices and SEO we used Chrome Developer Tools resource Lighthouse.

Lighthouset test

Back to the top of page


Deployment

Version Control

We used GitPod and Visual Studio Code as a local repository and IDE & GitHub as a remote repository.

Process for GitPod:

  1. The repository was created on GitHub and we gave it the named team-5-january-hackathon.
  2. We then opened that repository on GitPod by prefixing 'gitpod.io/' to the URL at the top of the page within this repository.
  3. GitPod opened new workspaces for us to use.
  4. Opened a new terminal.

Process for Visual Studio Code:

  1. We opened VS code on our local machines.
  2. Made sure we had git installed.
  3. Opened a new terminal.

Together using our terminals:

  1. We each created a new branch for each of us to use by typing: git name-of-branch
  2. We navigated to our branches by typing: git switch name-of-branch

Once we were in our branches we used:

  1. git pull origin main This pulls all data from the main branch.
  2. git add name-of-file This adds a file to be committed.
  3. git commit -m "Commit message" This allows us to attach a message to our committed code.
  4. git push origin name-of-branch This final command pushes our work to a branch of our choosing.

GitHub Pages

As a deployment solution to our project we chose to use 'GitHub Pages'. This is a resource a developer can use to test how their websites look on a cloud platform.

Here are the steps we took to deploy our website.

  1. In the repository we selected 'settings'.
  2. Within the options on the left middle of the screen we navigated to the 'pages' section.
  3. We then selected a branch to test.
  4. Once this was completed we received a URL for the website.

How to clone this Repository

Below is a list of steps to help you clone this repository:

  1. Please log in to your GitHub account to get started.
  2. Then create a new repository within your account and give it a name.
  3. In this repository at the top of the page click the green button labelled 'code'.
  4. Choose the HTTPS option and copy the URL link you see to your clipboard.
  5. You will need to open your 'IDE' and have 'git' installed.
  6. Once you have git installed open a terminal.
  7. Type: git clone URL-from-this-repository

Once steps 1 - 7 are completed you will now have a clone of this repository on your local machine to use.

Back to the top of page


The Team

This was my second Hackathon wit Code Institute. I could've not even imagine before that a team can be so collaborative. That was a really great experience for me. Thank you team!

This has been my first hackathon and I have really enjoyed it. Thank you to everyone within my team for your hard work! I look forward to the next one. Thanks everyone!

After one year without coding at all, this was my second Hackathon and I was a pleasure to be part of this great team. The teamwork was really nice. Thanks guys.

This was my third Hackathon and I must say it has been an absolute pleasure to be a part of this fabulous team. The teamwork has been fantastic. Thanks to all of you!!

This hackathon was a lot of fun for me. This was my first hackathon, and I'm happy for the experience and the opportunity to collaborate with such amazing people in the industry! Thanks everyone.

Credits

We would like to thank Kasia Bogucka for the cheering you supported us with during this Hackathon. Thank You 😃 Back to the top of page

About

Code Institute and Trust in SODA collaborative January 2022 Hackathon

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published