Code Sphere

This repository contains the Code Sphere platform, which facilitates online learning with roles for Students, Teachers, and Admins.

---

Frontend: Next.js Application

Features:

• User-friendly interface for students, teachers, and admins.
• Integration with APIs for user authentication, course management, and chat features.
• Responsive design for seamless experience across devices.

Installation:

1. Clone the repository:

   git clone <repository-url>
   cd code-sphere-frontend

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

4. Open http://localhost:3000 in your browser.

Folder Structure:

/my-nextjs-project
│
├── /public
│   └── (static files like images, icons, etc.)
│
├── /src
│   ├── /app                  # Pages and frontend components
│   │   ├── /components       # Reusable components
│   │   ├── /hooks            # Custom React hooks
│   │   ├── /pages            # Pages and route-specific components
│   │   └── /styles           # Global styles (CSS, SCSS, etc.)
│   │
│   └── /utils                # Utility functions (validators, helpers, etc.)
│
├── /tests                    # Unit and integration tests
│
├── /node_modules             # Node modules
│
├── /package.json
└── /tsconfig.json            # If using TypeScript

Deployment:

1. Build the production version:

   npm run build

2. Start the production server:

   npm start

---

Backend: Node.js + Express.js Application (Clean Architecture)

Features:

• RESTful API for handling authentication, course management, and messaging.
• Secure with middleware for validation and authentication.
• Scalable architecture following clean code principles.

Installation:

1. Clone the repository:

   git clone <repository-url>
   cd code-sphere-backend

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

4. The API will be available at http://localhost:5000 (or the port specified in .env).

Folder Structure:

/my-backend-project
│
├── /src
│   ├── /domain                  # Core business logic (entities, interfaces)
│   │   ├── /entities            # Business entities (e.g., User, Order)
│   │   ├── /interfaces          # Repository interfaces, service contracts
│   │   └── /valueObjects        # Value objects, like email or price
│   │
│   ├── /application             # Application-specific business logic
│   │   ├── /useCases            # Use case implementations (e.g., CreateUser)
│   │   └── /dtos                # Data Transfer Objects
│   │
│   ├── /infrastructure          # Framework and infrastructure code
│   │   ├── /database            # Database configuration and ORM setup
│   │   ├── /repositories        # Implementation of repository interfaces
│   │   ├── /routes              # Express routes
│   │   └── /services            # External services (e.g., email, third-party APIs)
│   │
│   ├── /presentation            # Web layer (controllers, middlewares)
│   │   ├── /controllers         # API controllers
│   │   ├── /middlewares         # Express middlewares
│   │   └── /validators          # Request validation logic
│   │
│   ├── /config                  # App configuration (e.g., env variables)
│   │   └── config.ts
│   │
│   └── /utils                   # Helper functions, utilities
│
├── /tests                       # Unit and integration tests
├── /node_modules                # Node modules
├── /package.json
├── /tsconfig.json               # TypeScript configuration
├── /eslint.json                 # Linter configuration
├── /prettier.config.js          # Prettier configuration
└── /dist                        # Compiled JavaScript code

Deployment:

1. Build the production version:

   npm run build

2. Start the production server:

   npm start

---

For further details, refer to the individual README files in each folder.