Hi, welcome to StoQuotes. StoQuotes is a Javascript frontend app with a Ruby on Rails API backbend where users have the ability to get quotes from a rich variety of methods, and write a story for any given quote. StoQuotes is a revamp of my very first app (a CLI ruby app), with many more functionalities added. For reference, the backend repo for StoQuotes can be found here. You can find also a Medium article for StoQuotes here.
StoQuotes consists of two main components: a Quote rendering and Story writing component, and a Story reading and editing component. I call the first component the "Black Box", as the box supports more than ten different functionalities. In Stoquotes users have the ability to:
- Get a description of the functionalities of the app on the app's landing tab, the Home tab.
- Get a random quote upon clicking the Quote tab, and continue to get a new random quote for each click on the Quote tab.
- Get a list of ten random authors upon clicking the Authors tab, and continue to get a new set of ten random authors upon each click on the Authors tab (the new set replaces the previous set upon each click).
- Get a list of ten categories upon clicking the Categories tab.
- Get an author-search form upon clicking the Search Author tab.
- Write a story within the Quute tab upon clicking on the "Wrtie a Story" button after the quote is rendered.
- Get a quote from any given author in the Authors tab upon clicking on an author's name, and continue to get a new quote from the author for each click on the author's name.
- Write a story for any quote rendered in the Authors tab.
- Get a quote upon clicking on any category name in the Categories tab, and continue to get a new quote from the clicked category for each click.
- Write a story for any quote rendered in the Categories tab.
- Write the name of an author in the form rendered by the Author Search tab. The name of the author will show up as an option if the author is in the database. Upon clicking on the "Get Quote" button, a quote from the selected author will be rendered; in addition, a new quote from the selected author will be renderd for each click on the "Get Quote" button.
- Write a story for any quote rendered in the Search Author tab.
- Some more functionalities...
Video walkthrough on YouTube: Stoquotes Demo
To run the app in your local machine follow the next steps:
- Clone this repository to your local machine:
$ git clone https://github.com/mmartinezluis/stoquotes-fronend.git- Clone the backend API repository for this app to your local machine:
$ git clone https://github.com/mmartinezluis/stoquotes-backend.git-
In the backend respository, run
bundle installto install lthe required gems. Then runrails db:migrateto crreate the migrations. -
Again, in the backend repository, run
$ rails db:seed(caution: once you run rails db:seed, the API will create more than 700 authors and more than 23,000 quotes with associations; it can take up to 7 minutes for this process to run; do not close the app or run other commands while the seeding process is in progress)
- Finally, for the backend, run
$ rails server- Last, for the frontend repository, open the file
index.htmlusing a live server (either right click on the file and click on 'Open with live server' or click on 'Go Live' on the blue bottom bar if using VS code). And now you are ready to go.
Contributions and pull requests are welcomed. You can also create an issue to report a bug or make a request. For pull requests, you may follow these steps:
- Fork and clone this repository.
- Create a branch name denoting the feature or bug. For example:
git checkout -b feature/new-featureorgit checkout -b bug/bug-fix. - Write your code and submit changes with a clear commit message.
- Push to the branch with
git push origin feature/new-feature. - Create a pull request, and explain the reason for the requested change (why the written code should be implemented).
StoQuotes is available as open source under the terms of the MIT License.