Description

IQ Degree is a comprehensive educational platform designed for children, offering a wide range of courses and interactive quizzes to enhance learning in a fun and engaging way. Built with modern web technologies, including React, Vite, TypeScript, Tailwind CSS, Express.js, MongoDB, and Mongoose, the platform aims to provide a seamless user experience for both students and educators.

Technologies Used

• React
• Vite
• TypeScript
• Tailwind CSS
• Express.js
• MongoDB
• Mongoose

Features

List key features and functionalities of your project.

Getting Started

Prerequisites

• Node.js (version x.x.x)
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/your/repository.git
   cd repository-name

2. Install dependencies:

   npm install
    # or
    yarn

Configuration

1. MongoDB Setup:

   • Install MongoDB locally or set up a cloud-based MongoDB instance.
   • Update MongoDB connection URI in server/config/config.ts.

2. Environment Variables:

   • Create a .env file in the root of the server directory for environment variables.

Running the Development Servers

1. Start the Express.js server (backend):

    cd server
    npm run dev
    # or
    yarn dev

   The server should start at http://localhost:5000.

2. Start the React development server (frontend):

    npm run dev
    # or
    yarn dev

   The React development server should start at http://localhost:3000.

The production-ready build will be created in the dist folder.

Building for Production

Directory Structure

your-app/
├── backend/
│   ├── src/
│   │   ├── controllers/
│   │   │   └── YourController.ts
│   │   ├── models/
│   │   │   └── YourModel.ts
│   │   ├── routes/
│   │   │   └── apiRoutes.ts
│   │   ├── services/
│   │   │   └── YourService.ts
│   │   ├── utils/
│   │   │   └── someUtility.ts
│   │   ├── app.ts
│   │   └── server.ts
│   ├── .env
│   └── tsconfig.json
├── frontend/
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── App.tsx
│   │   ├── index.tsx
│   │   └── ...
│   └── ...
├── .eslintrc.cjs
├── .gitignore
├── README.md
├── index.html
├── package-lock.json
├── package.json
├── postcss.config.js
├── tailwind.config.js
├── tsconfig.json
├── tsconfig.node.json
└── vite.config.ts

Contact Information

ayoub1dahmen@gmail.com | Linkedin | Instagram | +216 51 012 285