Giter VIP home page Giter VIP logo

all-booked-ms3's Introduction

All booked

All booked is an online platform for people who love to read. Our users are able to create an account that gives them access to a self curated collection of books. Users are able create personalised book lists that can be shared with other users. All booked stems from a book and discussion club that I used to attend.

alt text Please see the deployed site on Heroku here

Please see the repository on github here

UX

This website is for:

  • People who enjoy reading books
  • People who want to curate their collection
  • People interested in writing notes or reviews ion the books they have read.
  • People interested in getting new book recommendations.
  • Companies that may want to use affiliate links for the books linked to stores.

Wireframes

I created wireframes using Mockplus

Please see Wireframes here.

Fonts

The fonts chosen for the website are: Poppins was used for the body offering a Geometric sans serif typeface that is clear to read at every size. Nunito was used for the All booked logo. Nunito is a well balanced sans serif typeface superfamily.

Colours

I used Coolers to look up suitable colour schemes. I wanted colours that complimented each other but were also bold. My selection was limited due to using Materialize which has a selected range of colours that can be added.

alt text

User Stories

  • As an existing reader of books, I want somewhere I can see the books I've read in one place
  • As a potential user I want to find new books to read or add to my collection
  • As a potential user I want to be able to buy a book that interests me quickly
  • As a potential user I want to be able to build relationships with the people that share books via the website.
  • As a user I want something easy to use with no jargon
  • As a potential user I want something that looks fun and playful

Features

Existing Features

  • Collapsible Navigation menu – Users are able to move between pages with ease regardless of the size of their device.
  • Footer – features social media links.
  • Mobile First design – allows users to view the website across multiple platforms without compromising usability.
  • User account - Users data are save and encrypted withing their own personal account.
  • list- Users can create a list of preferred books in the account that can be edited, deleted and new ones can be added.

Features Left to Implement

  • Like/ voting abilities
  • Chat integration to allow users to discuss books in one place
  • Search bar that allows users to search the databas for previously seen books
  • Book of the month blog

Technologies Used

  • HTML5
  • CSS3
  • Python
  • Javascript
  • Mongodb
  • Materialize
  • Flask
  • jQuery
  • Marterialize 1.0.0
    • Used to simplify layouts and create consistency of design while enabling responsiveness.
  • Balsamiq
    • Created Wireframes for the project prior to development
  • Github & Gitpod
    • Used to write, store and view code
  • Google fonts
    • Used to select fonts for the project
  • Font awesome V5.15.2 -Used for mutiple icons throughout the site
  • Pexels
    • Used for background picture

Testing

My Code has been checked using:

My project has responded well to testing in various browsers on across multiple devices.

For more testing across multiple devices please see the All booked gets tested

Deployment

My project was deployed using GitHub Pages and Heroku

GitHub

  • Logged into my account on gitHub.com
  • I located my project repository
  • Selected settings
  • Selected pages on the lefthand side
  • I selected Master as the source in the dropdown menu
  • Pressed save
  • Page is automatically refreshed
  • I return to 'Pages' where the new link is available.
  • Clicking the link takes you to the deployed website. However, as it is already deployed on Heroku all you can see in the README.

Local Deployment, run using Gitpod

  • Add the Gitpod browser extension on Google chrome
  • Login to your GitHub account
  • Locate the project repository and select the green Gitpod button which will open a workspace.

Heroku

  • Logged into my account on Heroku.
  • Select 'Create new app'.
  • I put in the of my app and chose the region closest to me.
  • In 'Settings' I selected 'Config Vars'
  • I added the details from my env.py file. This includes the IP, Port, Secret key, MongoDB name and URI.
  • I selected the 'Deploy' option.
  • Under 'Deployment method' select the GitHub option to connect to your GitHub repository.
  • Select Automatic deploys from the main branch and click 'Deploy Branch'.

Credits

Content

  • I used Henrique's Book world as inspiration in regards to the layout and help make sure I was on track.
  • I used the Code institute mini project tutorial and source code to help build my project
  • Readme template helped me write my Readme file.

Acknowledgements

  • My sister Habiba being up during the late nights when I was stressing
  • Spencer the best for always being so willing to help me even when I go nuclear and lose/mess up my code. Or in this case change the whole layout.
  • The baby cat Moon who did his very best to code along even when he was more a distraction that a help.
  • My cousin Nina for starting a wonderful book club named all booked a few years ago that I miss.

all-booked-ms3's People

Contributors

marijoke avatar

Watchers

James Cloos 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.