GUESS THE QUOTE
It is a fun quiz game which is a progressive web app(PWA). Built during Collaborative Projects in Google Udacity Mobile Web Specialist Scholarship.This project is built to dive further deep into PWA and learn about caching music and animations using service worker.
Table Of Contents
- Features Wishlist
- Design Specs
- Requirements for Development
- Setup for Development
- Technology Stack
- Contributing Guidelines
Features Wishlist
- [ ] Login/SignUp
- [ ] A complete PWA for both web and mobile users
- [ ] GUI Animations(Using Greensock)
- [ ] TextToSpeech while reading the quote
- [ ] Share your score on Social Media (like Facebook for now)
Design Specs
- UI Designs
- Font: Gotham
- Colors: Random for every question/session.
Requirements for Development
Setup for Development
Refer this link for setup illustration with examples and images
- Fork the repository by clicking on the fork button on the top of the page. This will create a copy of this repository in your account.
- Click on clone or download and copy the url from your forked repo
-
Open a terminal(CLI) and run the following commands:
git clone https://github.com/<your-github-username>/guess-quote.git cd guess-quote npm run setup cp env.example .env npm start- Open any browser and goto http://localhost:3000 (The server is running on http://localhost:3001)
[OPTIONAL] Setup Upstreams
**Note**: An upstream repository is the original UdacityMobileWebScholarship repository. Once you have forked as directed in the previous section, you would not be following changes made here, in the original repository. **What you can do is:** - cd to the directory of the forked repo you cloned above. - Run a command to add upstreams ```bash git remote add upstream https://github.com/UdacityMobileWebScholarship/guess-quote.git git fetch upstream git checkout -b upstream/master git pull upstream master ``` **To return to your branch on your fork** - Run ```bash git checkout master ``` #### Next steps You are all good to start contributing. You might however want to make sure you periodically update the `origin/master` branch which is from your fork, with the content from `upstream/master` which is this repository's dev branch. **Why?** Because, Just before you submit Pull requests, or before you even change a feature, you **Need** to ensure you have all the latest changes from upstream. This is a healthy habit to inculcate, and would ease out headaches later. Also, Before you do the above , and begin coding something new, or modifying existing stuff, make sure you have **merged**. the simplest is a fast forward merge ` git merge upstream/master` But merges are complicated. Please do read official documentation on merge. Understand how they work. And then proceed to a PR.Discussion
- Join our Slack team at #cp_quote_app
Technology Stack
Contributing Guidelines
Contributions are always welcome. We are using Git Branching Model for production and development purposes.You can read more about it hear A successful Git branching model.Basically what this means is
develop: This branch reflects a state with the latest delivered DEVELOPMENT changes for the next releasemaster: This branch reflects the PRODUCTION READY STATE
For more details regarding contributing refer CONTRIBUTING.md