WordTester

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License
4. Contact
5. Acknowledgements
   • Related to Blazor
   • Related to C#
   • Related to images
   • Others

About The Project

There are several tools for learning foreign words using flashcards and spaced repetition, but I found that most of them don't include the functionality of learning in a context. The main goal of this project is to create an application that requires you not only to provide the translation of a word but also a definition and example use of the given word. Thanks to it, I believe that the quality of your learning and memorization will be greatly improved.

Built With

• .NET 5.0
• Blazor
• Azure Text to Speech

Getting Started

This section contains instructions on setting up the project locally.

Prerequisites

• Visual Studio 2019 16.8 or later with the ASP.NET and web development workload
• .NET 5.0 SDK or later

Installation

1. Clone the repo

   git clone https://github.com/KamilBugnoKrk/WordTester.git

2. Open in Visual Studio
3. Use your configuration data:

• appsettings.json:
  • SpeechServiceKey - your Azure Speech Key
  • FTPName - name of your FTP
  • FTPPassword - password to your FTP
  • FTPURL - URL to your FTP
• ReCaptcha.cs
  • secret - secret to your reCaptcha

4. Click IIS Express to run
5. The application will be available on https://localhost:44370/, API on https://localhost:44370/swagger/index.html

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

Kamil Bugno - Website

E-mail: hello@wordtester.org

Project Website: http://wordtester.org

Project Repository: https://github.com/KamilBugnoKrk/WordTester

Acknowledgements

It would not be possible to start developing this project without the great free resources. I would like to say thanks to all people who dedicate their time to develop open-source projects:

Related to Blazor

• BlazorWithIdentity - project template
• bUnit - testing library
• MatBlazor - material design components
• MudBlazor - component library based on Material design
• Blazored Modal - modal implementation
• Toolbelt.Blazor.HotKeys - keyboard shortcuts
• Blazor-UseGoogleReCAPTCHA - example usage of reCaptcha

Related to C#

• Flurl - HTTP client library
• xUnit.net - unit testing tool
• Fluent Assertions - Fluent API for asserting the results of unit tests
• Moq - mocking framework
• MediatR - mediator implementation
• combinatorics - combinatorics library
• NetArchTest - Fluent API for .Net that can enforce architectural rules in unit tests

Related to images

• unDraw - open-source illustrations
• Main photo by Avel Chuklanov on Unsplash

Others

• Best-README-Template - README template