/Eduvi-E-learning

Primary LanguageTypeScript

Eduvi E-Learning Platform

Welcome to Eduvi, an e-learning platform built using React with TypeScript and Vite. Eduvi aims to provide a seamless learning experience for students and instructors by offering a range of interactive courses and educational materials.

Getting Started

These instructions will help you set up and run the Eduvi E-Learning Platform on your local machine.

Prerequisites

  • Node.js
  • yarn

Installation

  1. Clone the repository:

    git clone https://github.com/Jima-J9M1/Eduvi-E-learning

cd Eduvi-E-learning

yarn install

2 Run Application: npm run dev

Folder Structure

The project follows a well-organized directory structure to maintain a clean and efficient codebase.

  • public: Contains static files accessible to the public, such as index.html and other assets.

  • src: The main source code directory.

    • assets: Static assets like images, videos, and more.
    • components: Reusable UI components.
      • common: Shared components like Header, Footer, etc.
      • course: Components related to courses.
    • pages: Individual pages of the application.
    • styles: CSS files for components and global styles.
    • utils: Utility functions and helpers.
    • App.tsx: Main application component for routing and layout.
    • index.tsx: Entry point of the application.

  • react-app-env.d.ts: TypeScript declarations.

  • .gitignore: List of files and folders to be ignored by Git.

  • package.json: Project configuration and dependencies.

  • tsconfig.json: TypeScript configuration.

  • vite.config.js: Vite configuration.

  • README.md: Documentation for the project.