Giter Club home page Giter Club logo

ms3-greatreads's Introduction

t# Milestone Project Three: Greatreads

User Experience (UX)

User Stories:

  • Registered Users
  1. I would like to browse for new books to read published by other users.
  2. I would like to see reviews for books so that I can see how good a book is.
  3. I should be able to sign in, sign out and sign up.
  4. Should be able to add new books with all relevant information.
  5. I should be able to access all relevant pages.
  • Unregistered Users
  1. I should be able to view books without signing up.
  2. I should be able to sign up to the site.
  • Admin
  1. Should be able to access all pages
  2. Should be allowed to change the weekly featured book.
  3. Should be able to add a book.
  4. Should be able to add review.

Design:

  • Colour I used an orange and white theme that I got inspiration from Colormind.

  • Imagery I used a simple repeating book background image for the background as I believe it gives the website a carefree feeling. BG-Image

  • Wireframe Homepage Profile Books Book Details Add Book Form Edit Book Form Login Signup

Features

Existing Features:

  • Responsive design for all devices.
  • Interactive database
  • Interactive elements

Features Left to Implement:

  • Ability to like books will be implemented in the future.

Deployment

  • I ensured my repo had been added, committed and pushed.
  • I ensured my var configs on Heroku were all correct.
  • I connected github to Heroku.
  • I deployed my project on Heroku.

Technologies Used

Languages Used:

  • CSS3
  • HTML5
  • Python

Libraries, Frameworks and Programs:

  1. Materialize
  • Used for styling, main components used were cards and the grid system.
  1. Jquery
  • Used for the nav.
  1. Font Awesome
  • Used to add icons to guide the users eyes appropriately.
  1. Github
  • Used for version control and for repositories.
  1. Gitpod
  • IDE used to create the site.
  1. Balsamiq
  • Used for planning of the project.
  1. Flask-Pymongo
  • Used to connect to MongoDB and develop with it.

Testing

  • Chrome Dev tools were constantly used to test the site and its responsiveness, also other web browsers were tested with the site.
  • Tested all links and buttons to ensure they were all connected appropriately.
  • Had family and friends test my site and give feedback to what I can improve.

Bugs that Need Fixing

  • A bug that needs fixing is that reviews show on all books instead of a specific one. I could not figure out the logic for this and will enquire with peers in the future to fix the problem.

Credits

Code:

  • Code was used from the Materialize framework to create the style of pages.
  • Code was used from the Code Institute Task Manager Mini Project to set up some of the log in/sign up functionality.

Media:

  • This is the background image used for the background of the site. BG-Image
  • This is the book cover for A Brief History of Time. book cover
  • This is the book cover for Dune. book cover
  • This is the book cover for It. book cover
  • This is the book cover for Annihilation. book cover

Acknowledgments:

  • I had help with design and code from my mentor Akshat Garg
  • I had support from community members on slack and stack overflow.

ms3-greatreads's People

Contributors

harbs1999 avatar

Watchers

 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.