A data repository for displaying data gathered from oireachtas API.
Displayed data will include the latest bill proposed in Irelands Government houses: Dail and Seanad.
The site will provide condensed descriptions of the elements of the oireachtas.
Hosted on GitHub Pages Repository on GitHub
The project is shared for use with the GNU General Public License v3
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Expected users of the website include lawmakers, educators, journalists and students of all kinds. They come to the website with questions in need of answering.
- A student user wants to learn more about the houses of the oireachtas
- An education professional user wants to share learning resources with their students
- A journalist user looking up the latest legislation
- Oireachtas member user searching for colleague information
- A political scientist looking for the party of a certain house member
- Colour scheme consists of complementary colours
- Tweaked versions of archaic government flag colours.
- irish-gold:
#FFA65D - patrick's-blue:
#D2E2FF
- Custom designed logo resembling five rows of dail and four rows of seanad seats.
- roboto font used throughout the website
- font-family: 'Roboto', 'helvetica' sans-serif;
The web app is a single page with different displays given for different functions:
Features planned, implemented and outlined for later development
- Documentation - ReadMe File, Licence & Mockups
- JavaScript focused development
- Data retrieval from Oireachtas API
- Page refreshes
- Dynamic content switching by house
- Bills
- Members
- Pagination
- Breadcrumbs
- D3/DC data charts
- Colour Scheme
- Custom Logo
- Favicon
- Jasmine Testing
- Bootstrap - HTML, CSS Framework
- Grid System - Columns and Rows
- Cards
- Icons
- Responsive design - Mobile First
- UX elements
- User Flow
- Animations
- Transitions
- Accesibility
- Git - Version Control System
- GitHub - Remote Repository
- Deployed - Hosted on Github Pages
- Documentation - ReadMe File, Licence & Mockups
- JavaScript focused development
- Data retrieval from Oireachtas API
- Page refreshes
- Dynamic content switching by house
- Members
- Pagination
- Breadcrumbs
- Colour Scheme
- Custom Logo
- Favicon
- Jasmine Testing
- Bootstrap - HTML, CSS Framework
- Grid System - Columns and Rows
- Cards
- Icons
- Responsive design - Mobile First
- UX elements
- User Flow
- Animations
- Transitions
- Accesibility
- Git - Version Control System
- GitHub - Remote Repository
- Deployed - Hosted on Github Pages
- D3/DC data charts
- Dynamic content switching by house
- Bills
- Show members by constituency
- GPS location
This project makes use of:
- HTML
- HTML for strucutre
- CSS
- CSS for Styling
- JavaScript
- JavaScript for application controller
- JQuery
- The project uses JQuery to simplify DOM manipulation.
- Google Chrome
- Used for browser and dev tools
- Mozilla Firefox
- Used for browser and dev tools
- Google
- Google was used for research.
- Bootstrap
- HTML and CSS Framework from Bootstrap
- Visual Studio Code
- This project was built using the VS Code IDE
- Git
- Git used for Version Control
- GitHub
- Repository hosted on GitHub
- Github Pages
- Website hosted on Github Pages
- Oireachtas API
- Data collected from the Oireachtas API
- Jasmine
- Development testing completed with Jasmine
- Am I Responsive
- Testing responsiveness of the website
The site was tested through a number of means.
Jasmine was used for test first development where tests are written first then the fuctionality is written to pass the tests. Steps to test with Jasmine are as follows:
- Open testing.html in the root directory
- Run using a live server process
- Visit the page with localhost:[port]/testing.html
- The opened page will show the result of the assigned tests
Alternatively:
- Visit the hosted version of the website
- In the url add testing.html/ to the end
- The opened page will show the result of the assigned tests
Tests were written first. Development met with hurdles that had to be worked around, making TFD infeasible in this case.
- A student user wants to learn more about the houses of the oireachtas
- From the Oireachtas page the user learns of the houses and members of the Oireachtas
- An education professional user wants to share learning resources with their students
- On the Oireachtas page the user clicks on a bill
- On the bill page in the related documents section the user clicks on a document
- The opened pdf is sharable with students
- A journalist user looking up the latest legislation
- On the Oireachtas page the user finds all the latest legislation
- Oireachtas member user searching for colleague information
- The user finds the name of the member they are searching for
- They click on the user
- In the opened page the user finds the required information of their colleagues
- A political scientist user looking for party breakdown of oireachtas houses
- The user finds the member from the Oireachtas page and click on them
- In the member information the user finds party membership information
The project is hosted on GitHub Pages
The process involved:
- Host a git repository on GitHub. Explained here.
- The root folder contains README.md and index.html files
- On GitHub repository settings page move to GitHub Pages section
- Change source to master branch. (Or any desired branch)
- Provided link will be your projects home (index) page.
To deploy your own version of the website:
- Have git installed
- Visit the repository
- Click 'Clone or download' and copy the code for http
- Open your chosen IDE (Cloud9, VS Code, etc.)
- Open a terminal in your root directory
- Type 'git clone ' followed by the code taken from github repository
git clone https://github.com/Pattern-Projects/oireachtas-ifd-project.git
- When this completes you have your own version of the website
- Feel free to make any changes to it
- The website can be run by opening one of the HTML files within a web browser
- Visit the link provided
- Your website with any made changes will appear
- Saved changes to the website will appear here after refreshing the page
The benefits of hosting your website on GitHub pages is that any pushed changes to your project will automatically update the website. Development branches can be created and merged to the master when complete.
It may take a moment for changes to appear on the hosted website.
During development the site is written in VS Code. It is run using Live Server plugin for VS Code.
The text on the website has been copied and edited from:
The images for the website are taken from:
Thank you to the following for inspiration, motivation and the direction I needed:
- Matthew James Taylor
- Seun Owonikoko @seun_mentor
- Simen Daehlin @Eventyret_mentor
- Robin Zigmond @robinz_alumni
- @Aymeric MC
- Edel O' Sullivan @Edel O'Sullivan
- John Lynch @John_Lynch_alumnus
- Code Institute