nk-mart / edx-group-2

edx group project 2
MIT License
0 stars 2 forks source link

Quote Collector

Description

This application was created to be similar to pinterest but for the quote lovers! The aim is to build a performant and scalable front-end single-page application that will fufill this desire. The user will be able to browse a variety of wise quotes to be inspired by and store away their favourite for the perfect occasion. They will then be able to easily find and copy them, ready to post wherever they wish. We intend for it especially to be utilised for things like twitter statuses.

We have utilised project planning and project management tools on GitHub, which enabled us to resolve merge conflicts and execute Git branching workflow collaboratively. The project provided us with an opportunity to demonstrate our problem solving skills As a group, we will be collecting "quotes" from an API, which are saved in the user's local storage.

Installation

There is no need to install this app, as it is a web application fully accessible from your browser link. A contibutor may access the app with approved permision by via VS code using the command npm run start which will open up the Quote Home page in a browser

Usage

Upon reaching the page the user will be able to click the next button to navigate through various meaningful quotes. They will have the option to select the 'Save' button on any of the quotes that they wish to store away for later use. To reach their quote collection the user will be able to navigate to their 'Collection Page' via the button on the navbar. Once they have reached their own personal collection page, they will have the option to scroll throught their favourite quotes, and copy to clipboard if they so wish. The user will then be able to post the quotes as they need wherever they like, for example as a twitter status.

The link to the deployed application is as follows: https://luxury-brigadeiros-a7c44d.netlify.app/

An image of the fully deployed working appication is below: Screenshot 2023-03-23 at 22 27 17

Credits

Lawrence Stopwar

Nicholas Martin

Angel Purschel

Leona Prabakar

To create this app we have used:

License

License: MIT

The license will be MIT open source, please see documentation for further details. https://opensource.org/license/mit/

How to Contribute

Contributor Covenant

This project will use the open source contributer covenant. Please see below:

https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md