Giter VIP home page Giter VIP logo

clare-supporters-club's Introduction

Clare Supporters Club

Milestone Project Four

Build Status

The deployed project can be found at: https://clare-supporters-club.herokuapp.com/

User Experience (UX)

Project Purpose

The focus of this application is to create on online platform for people who support the County Clare in respect of GAA. The application will allow users to become part of an online community that can buy merchandise of their favourite club at discount prices while contributing to the club itself.

The user will be able to view all the products that the application has to offer however if they wish to purchase from the site at the discounted prices they must register and become a member of The Clare Supporter's Club.

The project uses a postrges database and the application is set up with the Django framework.

This application is targeted at all supporters of County Clare of all ages and disciplines with merchandise on the website to accomodate everyone.

User Stories

  • As a user I’d like to be able to buy specific branded merchandise from the website, which would support my County
  • As a user, I’d like for the website to be user-friendly and easy to navigate
  • As a user, I’d like to be able to search the website/database for merchandise available.
  • As a user, I'd like to be able to access the data and experience all the site has to offer, regardless of device and browser type being used

Design Ideas

When I was thinking about the site design I decided I wanted to keep the colours of the county prevelant in it and also have images of the team prominent on the page. I wanted the site to be relatively easy to use as I was conscious that this site's target market is all age groups.

Font

I wanted the font to be a bold blue colour - fitting in with the Clare theme. I also wantde the font weight to be quiet heavy as I was conscious that the site may be accessed by older people who may find smaller text harder to read.

Colour Scheme

The colour scheme for me was a no brainer, the Clare colours of saffron and blue. Although the colours themselves may not marry very well, as the site is aimed to be accessed by Clare supporters I don't think the colour scheme would offend them.

Icons

I utilised font-awesome icons for my social links and also for my nav bar, just to add a nice visual touch.

Wireframes

As is tradition for me, my wireframes don't look exactly like my finished project.

On my wireframe of the products page I did not have a carousel of images as I felt that it may clutter up the site too much, however as the site progressed I felt the product page was lacking in something of impact and photo's of the team the user supports was a nice way to break up the page.

My wireframes can be found in the wireframes folder.

Features

Current Features

  • Feature 1 – Navigation
    • The nav bar displays a logo for the Clare Supporters Club and links with social icons encourage the user to register, login and view cart.
    • The options displayed will change on the navbar depending if the user is "logged in" or "logged out". Should the user be "logged in" the navbar will display a "log out" option and a profile option.
  • Feature 2 – Home Page/Product Page
    • Here the user sees a carousel of images from previous Clare Match events. If they scroll down they are greeted with the merchandise that is availableto them and the price.
    • When logged in the user will be able to access the user’s account page as well as being able to log out.
    • If the user is not logged in they will have the option to go to the registration page or alternatively add items to their cart and then register before checking out the items.
  • Feature 3 – Search Bar
    • The search bar is available across the application and allows the user to search for particular merchandise that they would like to view/purchase.
  • Feature 4 – Register
    • Users can use the site to view merchandise without registering however if they wish to purchase merchandise at the discounted rate on the website they cannot do so unless they register to Clare Suppoerts Club.
    • When the user registers their data is stored in the database and remembered for future logins.
    • Usernames must be unique and should a user select a name that has already been used they will be advised of same.
  • Feature 5 – Log In
    • If a user is registered, they can navigate to the login page from the navbar where their data will have been stored in the database requiring them to enter their email and password.
    • Should a user forget thier password they can click on the "Forgot your password?" link and they will be directed to the relevant page to be issued a new one.
    • Once the user logs out a message will be displayed to advise them that they have logged out successfully.
  • Feature 6 – Cart
    • As the user is shopping they will be able to see how many items are in their cart by the icon in the navbar.
    • The user can edit the quantity of items in their cart by clicking on the cart icon and editing the quantity before checkout
    • The user will then be able to access the checkout from the cart by clicking on the checkout button, however this will take them to a login screen should they not logged in already.
  • Feature 7 – Checkout
    • At checkout the user will have to fill out a form with their shipping details and also their credit card information.
    • The checkout feature is only available for users who have signed up for Clare Supporters Club
    • Once the user has paid a message will be displayed to advise them of same.
  • Feature 8 - Log Out
    • When a user decides they want to log out of the site, the option to do so is located on the navbar once the user is logged in.
    • Once the user chooses to log out, they will be taken back to the home page as a guest, with the default nav options available for a guest user (Home, Reviews, Register, Log In, Merchandise, Cart).

Future Features

  • Ideally I would love for users to be able to leave a product review after purchasing
  • I would also like to implement an area for users to discuss their shared interest of Clare as I feel this would help expand the site and enforce a positive community feel.

Technologies Used

  • Amazon AWS Cloud 9
    • Amazon AWS Cloud 9 was the IDE I used for this project, and I really feel it will be the last time I do.

Front-end technologies

  • HTML5

  • CSS3

  • Javascript/JQuery

  • Bootstrap

  • Font Awesome

Back-end technologies

  • Python

  • Django

Databases

  • Postgres/SQLite3
    • Postgres was used for the database for the deployed project.
    • SQLite used in test environment

Version control

  • Git & GitHub
    • Git used for version control
    • GitHub used as a remote repository

Deployment

  • Heroku

Payment processing

  • Stripe API

Testing

Using Travis I set up Continous Integration which automated testing for every app. I acheived this by creating a .travis.yml file and also linking my GitHub repository to my Travis account. Using thr Travis Markdown I was able to see clearly wqhen the code was passing or failing. Everytime new code was pushed to GitHub it was tested through Travis.

Using ChromDev Tools I tested the app on responsive screens ranging from S5 to IPAD to see if there were formatting issues. I ran into issues with my navbar on the smaller screens as the collapse menu was dropping down too far and floating to the right - I rectified this my adjusting my navbar to masthead.

Testing was also carried out within the application which can be viewed in the app folders named test.py or test_****.py.

I carried out manual testing on the webiste by going through it as a user

  • I registered as a user on the website
  • I added merchandise to my cart
  • I edited the quantity in the cart
  • I proceeded to checkout and paid for the items
  • I received the alert message to advise me that the transaction had gone through
  • I checked my stripe account and the payments had gone through successfully

  • I went onto the app as a guest User
  • I added items to cart
  • I went to purchase and the website directed me to login page which gave me the option of registration if I did not have log in details.

  • I manually tested the search box

  • All forms work and all display errors should the fields not be filled out correctly

  • Social links and email links in the nvabar all oparted perfectly when tested

  • I also sent the link for my application to family and friends who tested it out for me too with no issues reported back.

Deployment

  • I created this project in the AWS Cloud9 IDE. Within the terminal using git I pushed to my repository on Github.
  • I created an app on Heroku and deployed from same.
  • In Heroku deployment method was set to Github with automatic deploys set from the master branch.
  • The app was then deployed via this link: "https://git.heroku.com/working-it-out.git".

To clone the repository:

  • Select the Repository from Github.
  • Click on the "Clone or download" green button
  • Click on the "clipboard icon" to the right of the Git URL to copy the web URL.
  • Open your IDE and navigate to terminal window
  • Change the directory to where you want to clone the repository to.
  • Paste the Git URL copied from above and click "Ok".

Credits

  • Credit has to go to Code Institute and all their staff for helping me along the way. For this particular project I found the Full Stack Module was the module I referred to most for tutorials and guidance.
  • Carousel was taken from Bootstrap
  • Inspiration and logo was taken from Club Clare

Acknowledgements

I would just like to thank everyone from Code Institute for everything over the past year. It has not been easy but having such a great support system and a great peer group has made what seem to be irreversible problems solvable. Special thanks to my mentor Simen and all the team at Student Care.

clare-supporters-club's People

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.