Skip to content

Web app written in Angular with one goal - simplify learning process... for free.

License

Notifications You must be signed in to change notification settings

janpabisiak/Learnee

Repository files navigation

obraz

Learnee GitHub license

Learnee is a web app developed in Angular whose main goal is to provide a free and convenient solution for learning new terms. With six built-in games, you can broaden your horizons more rapidly than even before, and thanks to gamification (in the form of daily stats and XP system), you will be more motivated to succeed in your ambitions in fun way.

Learnee was created to enhance my personal learning process as a free, privacy-oriented, and ad-free alternative to other similar apps.

Demo

Features

  • Terms management: Allows users to easily add, edit, and delete terms. Users can also easily decide which terms they want to learn and which they don't.
  • Auto-generated definition: Learnee will provide you example definition for a given word, thanks to its connection with an external API.
  • Word of the day: Get a daily suggested term to learn.
  • Search and sort: Quickly find specific words with a search bar and sort options.
  • User settings: Select between light and dark mode, and export or delete your data with ease.
  • Pagination: Efficiently navigate through large datasets with pagination controls. Decide how many terms to display per page.
  • User statistics: Visual representations on a heatmap chart with the number of plays from the latest 30 days.
  • XP system: Gain XP points for every won game and lose them if your answer is incorrect.
  • Games included: Start learning by playing one of 6 included game: quiz, matching game, true of false, fill gaps, and listening game.

Tech Stack

HTML5 CSS3 TypeScript Angular Jasmine TailwindCSS

Run Locally

I. Clone the project

git clone https://github.com/janpabisiak/Learnee.git

II. Go to the project directory

cd Learnee

III. Install dependencies

npm install

IV. Create environment files using sample file (src/environment/environment.sample.ts).

V. Start the app instance

npm run start

Run unit tests

To execute unit tests with the Karma test runner, use the following command:

npm run test

Credits

This project uses Ionicons, Lingua Robot API and Merriam-Webster's WOTD RSS Feed.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Web app written in Angular with one goal - simplify learning process... for free.

Topics

Resources

License

Stars

Watchers

Forks