represent-the-10

Welcome to the Represent the 10 project page, created by Code the Change UBC! Represent the 10 is a website designed to represent the deaf peoples and deaf communities across Canada.

The website has two main functionalities:

1. Be an educational page about the deaf peoples and the deaf communities across Canada.
2. Contains a signable petition to the federal government requesting better acknowledgement of the rights of these peoples and communities.

Framework/Dependencies

Using pure Javascript, HTML5, CSS3 with the following libraries:

Bootstrap.js version 3.3.6

JQuery.js version 1.12.4

Browser Support

Chrome Yes

Firefox Yes

Safari Yes

IE 10+

File structure

app (root folder for all project files)

|--> index.html (website landing page)

|--> style.css (style css styles for all pages)

|-- html (folder containing all the .html files, one per page)

|-- img (folder containing all the images)

  |--> <PAGE_NAME> (one folder per page)

|-- js (folder containing all the .js files, one per page and one per cross-page functionality. Ex. Navbar)

Main Contributors

Team Leads

Evan Waterman - @EWaterman

Tyler Young - @tyler310

Developers

Seung Won Lee - @leesw98

Farhan Kassam - @farhankassam2

Contributing

Coding contributions to be made by members of Code the Change UBC only.

When making a contribution, make sure to do the following:

1. Assign yourself to an issue
2. Make sure you git pull the latest changes to the master branch
3. Checkout a new branch git checkout -b [name_of_your_new_branch] to commit your changes to
4. Make (and test!) your changes.
5. git commit -m "ADD A DETAILED DESCRIPTION OF YOUR CHANGES HERE" to commit your changes to the branch
6. git push origin [name_of_your_new_branch] to push your changes to the repo
7. Create a Pull Request into the master branch
8. After approval from at least one supervisor (@tyler310 or @EWaterman) merge branch into master.

Good IDE's:

Web Storm (can get free student account): https://www.jetbrains.com/webstorm/

Sublime Text (free): https://www.sublimetext.com/

Installation

Clone the repo from:

• HTTPS git clone https://github.com/CodeTheChangeUBC/represent-the-10.git

• SSH [email protected]:CodeTheChangeUBC/represent-the-10.git

Go to file:///C:/<PATH-TO-PROJECT>/represent-the-10/app/index.html in your browser

Naming Conventions

Folder and File Names: lowercase-hyphenated

CSS

Class / ID Names: lowercase-hyphenated

JavaScript

Class Names: CamelCase (starting with upper case)

Method Names: camelCase (starting with lower case)

Global Variable / Constants Names: UPPERCASE

Local Variable Names: camelCase (starting with lower case)

Found a Bug?

To provide suggestions or report bugs, open an issue first to discuss potential changes/additions.

Contact

Code the Change UBC

• Homepage: https://codethechangeubc.org/
• e-mail: [email protected]
• Facebook: https://www.facebook.com/codethechangeubc/

Represent the 10

• e-mail: