-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:jw20191n/scribble-learn-frontend
- Loading branch information
Showing
1 changed file
with
29 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,30 @@ | ||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| <h1 align="middle" > Scribble Learn </h1> | ||
|
|
||
| ## Description:beginner: | ||
| Scribble Learn is a drawing and guessing game aiming to assist EFL learners studying English vocabularies. | ||
|
|
||
| ## Problem Statement:bangbang: | ||
| Vocabulary plays a vital role in learning English (Huang, Yang, Chiang, & Su, 2015). However, researches showed that English as Foreign Language (EFL) students tend to have difficulties with vocabulary learning (Ghazal, 2007; Yang & Dai, 2011). Scribble Learn is a drawing and guessing game. This game aims to serve as an assisting tool to increase class engagement and motivate learners in vocabulary learning by engaging them in an enjoyable and satisfying game involving deep processing. | ||
|
|
||
| ## [video demo](https://youtu.be/s9RY32CvFbw):play_or_pause_button: | ||
|
|
||
| ## How to play:question: | ||
| 1. Teachers set up a game with a list of words aligned with the English course curriculum. | ||
| 2. Students join a game that their teacher set up with a secret passcode. | ||
| 3. When everybody is ready, the game starts. | ||
| 4. One game consists of a few rounds in which every round a student has to draw the teacher assigned word, and others have to guess it to get points. | ||
| - If you are a drawer: You have 30-second to draw at each round. | ||
| - If you are a guesser: You have 30-second to guess from the context, what the target vocabulary is. | ||
| 5. The round is over! The correct answer would be displayed on the screen, followed by a list of points students earned from the current round. | ||
| 6. Players take turns to draw and guess. | ||
| 7. The game is Over! | ||
| 8. A ranking of each student's points being displayed. | ||
| 9. You would receive an individual summary of the word that they didn't guess right. Or a word you drew, but nobody guessed right! <br/> | ||
| Try to memorize the word better or improve your drawing! :sweat_smile: | ||
|
|
||
| ## Technology:hammer: | ||
| * Programmed drawing games with HTML Canvas that allow users to draw with the cursor on the webpage. | ||
| * Incorporated Node.js and Socket.io to allow multiple players take turns drawing and chatting through the server. | ||
| * Built and designed the database schema with Rails and ActiveRecord to store user information and gameresults. | ||
| * DesigneduserinterfacewithReact.js,BootstrapandCustomCSS. | ||
|
|
||
| ## Available Scripts | ||
|
|
||
| In the project directory, you can run: | ||
|
|
||
| ### `yarn start` | ||
|
|
||
| Runs the app in the development mode.<br /> | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
|
|
||
| The page will reload if you make edits.<br /> | ||
| You will also see any lint errors in the console. | ||
|
|
||
| ### `yarn test` | ||
|
|
||
| Launches the test runner in the interactive watch mode.<br /> | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
|
|
||
| ### `yarn build` | ||
|
|
||
| Builds the app for production to the `build` folder.<br /> | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
|
|
||
| The build is minified and the filenames include the hashes.<br /> | ||
| Your app is ready to be deployed! | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
|
|
||
| ### `yarn eject` | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can’t go back!** | ||
|
|
||
| If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. | ||
|
|
||
| Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. | ||
|
|
||
| You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. | ||
|
|
||
| ## Learn More | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
|
|
||
| ### Code Splitting | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting | ||
|
|
||
| ### Analyzing the Bundle Size | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size | ||
|
|
||
| ### Making a Progressive Web App | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app | ||
|
|
||
| ### Advanced Configuration | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration | ||
|
|
||
| ### Deployment | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/deployment | ||
|
|
||
| ### `yarn build` fails to minify | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify |