Skip to content

README.md

Latest commit

 

History

History
127 lines (91 loc) · 1.75 KB

README.md

File metadata and controls

127 lines (91 loc) · 1.75 KB

EduMath-Track

EduMath-Track is a full stack educational platform designed to help students practice arithmetic operations while tracking their performance and progress over time.

Features

  • User authentication with JWT
  • Practice mode with dynamic problem generation
  • RESTful API architecture
  • Performance tracking
  • Session history storage

Tech Stack

Frontend:

  • React
  • TypeScript
  • React-Router

Backend:

  • Node.js
  • Express
  • TypeScript
  • Zod

Database:

  • PostgreSQL

Project Structure

backend/
  src/
    controllers/
    services/
    routes/
    middlewares/
    schemas/
    app.ts
    index.ts

frontend/
  public/ # contains static files
  src/ # Main directory 
    app/ # Global app configuration

    features/ # Organizes code based on functionalities (feature-based-architecture)
      auth/
        components/
        hooks/
        services/

      game/ 
        components/
        hooks/
        utils/

      stats/
        components/
        hooks/

      settings/
        components/
        hooks/

    pages/ # Contains pages associated to the routes

    shared/ # Contains reusable code without specific feature
      components/
      hooks/
      utils/
      types/

    styles/ # Contains global UI

    main.tsx

.gitignore
LICENSE
README.md

Installation

Clone the repository:

git clone https://github.com/LuisDev912/EduMath-Track.git

Install dependencies:

cd backend
npm install
cd ../frontend
npm install

Start development servers:

npm run dev

Future Improvements

  • Implement difficulty levels
  • Add weekly performance analytics
  • Dockerize application
  • Add automated testing

License

This project is under the MIT license.