Giter VIP home page Giter VIP logo

book-club-3's Introduction

image

UX User Experience

User Stories

All pages on this website are responsive to desktop, iPad and, mobile screens. Every effort has been made om making this website to be as intuitive as possible.

  • First Time Visitor Goals

  • As a First Time Visitor, I want to easily find a book I want to read.

  • As a First Time Visitor, I want to be able to easily navigate throughout the site to find content.

  • As a First Time Visitor, I want to look for reviews to understand what their users think of them and see if they are trusted.

  • Returning Visitor Goals

  • As a Returning Visitor, I would like to write a review about a book I have recently read/purchased from the online store.

  • As a Returning Visitor, I want to find the best way to get in contact with the organisation with any questions I may have.

  • As a Returning Visitor, I would like to edit a book I added to the website.

  • As a Returning Visitor, I would like to Remove a book I added to the website.

  • As a Returning Visitor, I would like to delete a review I left on a book.

Wireframe Mockups:

Desktp

image

Tablet

image

Mobile

image

Features

Existing Features

- Colour Scheme

-o The font families used in this project are: image

The choice of colurs evolved during development.

- NAV Bar

- Features

  • Menu options available to none members.

image

  • Menu options available to members.

image

  • Menu options aviable to admin members.

image

- Home Page

- Features

  • A search box in which users can search for their favorite books by title, author or category.
  • Small book cards with image, title, and author name, which on click navigates users to a page with full information of each book.
  • When aa member is logged in the edit and delete buttons are available.

image

- Profile Page

- Features

  • Book cards with image, bestseller(if selected at adding or editing), category, title, author name, page number and ISBN numbers and purchase link.
  • Book description.
  • Back button to return to home page.
  • If logged in the option to leave a review if not a message suggesting you register.
  • Lists any reviews already posted for this book.

image

- Edit Book Page

- Features

  • Book cards with image, bestseller(if selected at adding or editing), title, author name, page number and ISBN numbers and purchase link.
  • Edit button sends any amended data to the database, and a message of an updated book.
  • Cancel button to return to home page.

image

- Add Book Page

- Features

  • Book cards with image, bestseller(if selected at adding or editing), title, author name, page number and ISBN numbers and purchase link.
  • Edit button sends any amended data to the database, and a message of an updated book.
  • Cancel button to return to home page.

image

- Manage Category Page

- Features

  • Book card category field.
  • Edit button sends any you to the category edit page.
  • Cancel button to return to home page.

image

- Edit Category Page

- Features

  • Book card category input field.
  • Edit button sends the new category data to the database.
  • Cancel button to return to home page.

image

- Login Page

- Features

  • Book card username input field.
  • Book card password input field.
  • Login button to access member data.

image

- Registration Page

- Features

  • Book card username input field.
  • Book card email input field.
  • Book card admin access request field.
  • Book card password input field.
  • Register button to register on a website.

image

Yet to be implemented

  1. The addition of an edit user details.
  2. The ability to recover access if password forgotten
  3. The option to add a user photo or avatar - mongo database restricts storage of large files.
  4. To introduce coding to allow a two level membership, member and admin. Currently the new user can request admin rights but only one admin is currently supported by the coding.

Techologies Used

Languages

Libraries & Framework

Tools

Testing

Please refer ro the Testing.md

Deployment

The project after the completed code has been committed and pushed to GitHub can be deployed and found here.. This is achieved by navigating to the page holding the project repository and executing the following steps:

  1. From the menu select Settings.
  2. Scrolling down the vertical menu (topped by Options) select Pages which leads to the Source section.
  3. Under Source click the drop-down menu labelled None and select Main Branch.
  4. You are then required to choose a folder, either Docs or root. You should select root.
  5. You can now save these selections and the link to the deployed website will be displayed.
  6. The website is live https://davej66.github.io/m2-travelseeker/ .

To run the project locally github:

To achieve this by the following process;

  1. Under the repository name and the menu that contains Gitpod click Code.
  2. Select HTTPS the location will already be present.
  3. To the right of this address is an icon once this clicked the location will be cloned.
  4. the clone can be found at this https://github.com/Davej66/book-club.

To run the project locally heroku:

To achieve this by the following process;

  1. Create a requirements.txt file using the terminal command pip freeze > requirements.txt.

  2. Create a Procfile with the terminal command echo web: python app.py > Procfile.

  3. git add and git commit the new requirements and Procfile and then git push the project to GitHub.

  4. Create a new app on the Heroku website by clicking the "New" button in your dashboard. Give it a name and set the region to Europe.

  5. From the heroku dashboard of your newly created application, click on "Deploy" > "Deployment method" and select GitHub.

  6. Confirm the linking of the heroku app to the correct GitHub repository.

  7. In the heroku dashboard for the application, click on "Settings" > "Reveal Config Vars".

  8. Set the following config vars: Key Value IP 0.0.0.0 MONGO_URI mongodb+srv://:@<cluster_name>-qtxun.mongodb.net/<database_name>?retryWrites=true&w=majority PORT 8000 SECRET_KEY <your_secret_key>

  9. In the heroku dashboard, click "Deploy".

  10. In the "Manual Deployment" section of this page, made sure the master branch is selected and then click "Deploy Branch".

  11. The site is now successfully deployed.

Credits

I have used the following 5 websites to gather inspiration for content.

Acknowledgements

Thanking my mentor Richard Wells for his invaluable guidance and continuing support. His input & enthusiasm during the mid-review, furthermore at the final review was invaluable.

Support from the slack community when seeking assistance for the wealth of infomation available.

I have learned more in detail about how to complete my README from Anna Gilhespy's project available in codeinstitutes slack community template.

book-club-3's People

Contributors

davej66 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.