tsepuri / MiaLexi

Focus on one word at a time

Home Page:https://mialexi.up.railway.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MiaLexi

Focus on one word at a time while reading

Description

The purpose of this website is to enhance the user’s reading speed by displaying one word at a time, allowing the user to not only focus better when reading but also to prevent getting lost in the page. MiaLexi allows the user to choose how fast they would like to read. This website is also geared for educational purposes and children, since MiaLexi also allows censorship of certain words that the user would not want to see. MiaLexi will contain an authentication feature in order to keep track of the readings for the user. This website can be used for improving reading speed, while also having the ability to censor words that they deem inappropriate. The goal of this website is to allow the user to improve their reading speed, while our main objective with MiaLexi is to have it more accessible for users and schools. MiaLexi can run on any browser on a PC or laptop.

Getting Started

MiaLexi

Dependencies

  • Java 11
  • Node
  • Maven (optional)

Installing

  • Clone Git repository
cd Mia-Lexi
cd frontend
npm install

Executing program

npm run build
cd ../server 
./mvnw spring-boot:run
  • Open localhost:8080 on chrome

Help

  • Find frontend testing at frontend/tests/unit
cd frontend
npm run test:unit

[while server is running]

  • Find backend testing at server/src/test

  • Only demo text available in practice mode when you run our code locally

  • If you use the supplied url you can access full practice mode

Authors

Contributors names and contact info

Acknowledgments

  • Qinyong Wang
  • Professor Xiao

About

Focus on one word at a time

https://mialexi.up.railway.app/


Languages

Language:Vue 44.1%Language:Java 34.5%Language:TypeScript 18.5%Language:JavaScript 1.1%Language:CSS 1.1%Language:HTML 0.7%Language:Shell 0.0%