Skip to content

A webpage application that provided the user with an inspirational quote on opening the webpage. There are over 1,600 quotes stored using mySQL and Express for Node.js for web serving. The application is hosted on Heroku.

License

Notifications You must be signed in to change notification settings

Mark33Mark/quoted

Repository files navigation

Mark Watson

Get your Quote for the day

Table of Contents

  1. Project Description
  2. Application Features
  3. Installation
  4. Usage
  5. Credits
  6. License
  7. Repository Status
  8. Contribute
  9. Tests
  10. Checklist

1. Description

What is this project?

  • I originally wanted to see if I could get Heroku to work with mySQL. I like reading quotes so I thought I'd have a go at creating a SQL database of quotes.

  • I've refactored this project now for Netlify using lambda functions.

Why this project?

  • Quotes can be inspiring, make you refocus, feel energised, feel the deeper understanding humans are capable of.

landing page

What problem does this project solve?

  • Provides a polished mobile responsive website that accesses a mySQL database hosted on Heroku that randomly selected from approximately 1700 quotes.
  • Routes to update, delete and post quotes have been coded however they are for administrators and I ask that you respect the database and not work out the routes to modify it.

Lessons learnt?

  • It was challenging setting up SQL to work on Heroku however I found a great walkthrough that helped a lot. See Credits.

2. Features

  • provides access to a database of over 1,600 quotes.
  • when the page is opened there is SQL query that randomly selects a quote for you and prints it to the page.
  • there is a button if the user chooses to request the database provide another random quote, should 1 quote for the day not be enough.
  • the webpage has a polished and mobile-responsive user interface that should be readable on smaller devices in both portrait and landscape.

3. Installation

You can download the source code from my Github repository and install the dependencies, Node and Express, to be able to run the app on your localhost.
Alternatively, the webpage has also been hosted via URL: quote.watsonised.com or at URL: Heroku


4. Usage

The code can be downloaded from my Github repository for all assets created for the project.
You can modify the code as you need.


5. Credits

Huge thanks go to BezKoder for a really well set out and explained walkthrough that I relied on heavily to do this project website link Also the University of Sydney FSF Bootcamp course that provided great guidance for this project from the course content.


6. License

The works in this repository are subject to:

GitHub


7. Github repo status

GitHub top language GitHub language count GitHub last commit GitHub commits in last month GitHub commit checks state


8. How to Contribute

If you would like to contribute, please comply with the Contributor Covenant Code of Conduct:

Contributor Covenant


9. Tests

  • No tests have been prepared yet for this project.
  • The UI of the completed app has been tested on an iPhone 8 and Samsung Note 10+.

10. Checklist

All actions not checked are still to be completed:
[x] A MVP completed for distribution.
[x] Page responsiveness for different devices tested.
[x] The routes for deleting, posting, pushing have all been tested and work as expected.
[x] Webpage has a polished and mobile-responsive user interface.
[x] Webpage is hosted on Netlify
[x] Repository contains a README file with descriptio, screenshot and link to deployed application.


Back to the top

About

A webpage application that provided the user with an inspirational quote on opening the webpage. There are over 1,600 quotes stored using mySQL and Express for Node.js for web serving. The application is hosted on Heroku.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published