diff --git a/README.md b/README.md index 7c5d749..2b446d8 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,120 @@ -

Wordally

+ +

Table of Contents

+ -09.08.2020 - 13.08.2020 (v1.0) +

Description

+

Wordally is a digital solution for those who seek an efficient way to learn foreign language vocabulary for school purposes or to extend their terminology stock. Acquire the habit of studying vocabulary using the Wordally scheme to shorten the time needed to memorize and strengthen memory.

+

How To Use

+

Copy this link into your web browser

+
    +
  1. Enter all words and their corresponding translations in the first page (Step 1). +
  2. Guess the hidden translations in the right column. Press the magnifying glass to view the answer (Step 2).
  3. +
  4. Guess the hidden word in the left column. Press the magnifying glass to view the answer (Step 3).
  5. +
  6. Type out the word for the corresponding translation (Step 4).
  7. +
  8. Verify your results and receive your score (Step 5).
  9. +
  10. Copy the URL using the buttom on the bottom right to test your skills again!
  11. +
+

It's that simple. By repeating this method at least 3 times (with breaks between each try), it's possible to learn terminology in 30 minutes.

-

Description

+

How To Contribute

+
    +
  1. Make sure you have installed Node.js
  2. +
  3. Fork the repository
  4. +
  5. Clone the repository
    git clone https://github.com/trolit/Wordally.git 
  6. +
  7. Create your feature branch
    git checkout -b my-new-feature 
  8. +
  9. Test and commit your changes
    git commit -am 'added feature 
  10. +
  11. Push to branch
    git push origin my-new-feature 
  12. +
  13. Create a Pull Request
  14. +
-

Wordally is digital solution for those who seek efficient way to learn foreign language vocabulary for school purposes or to extend terminology stock. Acquire habit to study vocabulary like in Wordally scheme to shorten the time needed to memorize and strengthen memory. Implemented idea comes from author's private experience from learning english words. - -> Method relies on 3 steps. In first two, cover one column and try to guess hidden words by looking at visible column, then swap(do the same for opposite column). If you don't know something, don't worry just repeat that step few times. It's also worth to not guess words in the same order. In last step, write translations on sheet of paper(again, don't always write them in the same order) and then try to write all words. It's that simple. By doing that method at least 3 times(with breaks between each try) it's possible to learn terminology in 30 minutes(motivation also matters) :)

+

Project Directory Structure

+

Here is a simplified project structure so that you can understand what goes into the creation of this project.

+
+assets/
+  ├── css/
+  │   ├── blk-design-system.css
+  │   ├── blk-design-system.css.map
+  │   ├── blk-design-system.min.css
+  │   ├── nucleo-icons.css
+  │   ├── PlaylistRow.tsx
+  │   ├── PlaylistSearch.tsx
+  │   └── PlaylistTable.tsx
+  ├── js/
+  │   ├── core/
+  │   ├── plugins/
+  │   ├── blk-design-system.js
+  │   ├── blk-design-system.js.map
+  │   ├── blk-design-system.min.js
+  │   ├── wordally_Misc.js
+  │   └── wordally_Renderer.js
+  ├── scss/
+  │   ├── blk-design-system.scss
+  │   └── blk-design-system/
+  │       └── bootstrap/
+  │           ├── mixins/
+  │           └── utilities/
+  │       └── custom/
+  │           ├── cards/
+  │           ├── mixins/
+  │           ├── sections/
+  │           ├── utilities/
+  │           └── vendors/
+  ├── fonts/
+  ├── img/
+  └── sounds/
+
-

Notes

+

Notes

+ -- If you want to check Wordally, click on this link (it includes parameters in URL so you won't have to write words and translations manually, they will be added automatically) -- Primarily I wanted to make user only type words while translations would be served by Marak's translate.js library but didn't notice that it's old solution and Google API used there was depracated. Now when Google API is limited to "quota cost", I've decided that Wordally will require to write those translations manually. However, after finishing all steps you can generate URL for your word/translation template and when you use that generated URL JavaScript will will those inputs for you! -- Test it on phone:P -- Add at the end of generated URL ```&onlytest=true``` param to force Wordally to redirect to tab with verification sequence and hide back button. (example) +

Screenshots

+ + + + + + + + + +
#toadd#toadd
#toadd#toadd
-

Screenshots

+

Tech Stack

+

This application was built using the following tools/libraries.

+ +

Refer below to the list of references to learn more about these resources.

+

References

+ -| | | -| :---: | :---: | -| #toadd | #toadd | -| #toadd | #toadd | - - -

References

- -- BLK Design System (Bootstrap 4 Kit) -- gulp.js -- Node.js v12.16.2 -- Wordally logo -- clipboard.js -- Font Awesome Animation -- Iconify icons -- Nucleo icons(shared by Creative Tim) -- Error sound(licensed under CC BY-NC 4.0) - -

License

- -Wordally is licensed under MIT and is open source :] - -
-
- -Template generated using EzGitDoc +

License

+

Wordally is licensed under MIT and is open source :]

+

Template generated using EzGitDoc