Steex

This repository contains both the frontend and backend code for a learning management software.

Table of Contents

1. Project Overview
2. Technologies Used
3. Getting Started

Project Overview

Steex is a comprehensive platform designed to streamline the management of educational content, facilitate online learning, and enhance the learning experience for students

Technologies Used

Steex is built with the following technologies:

• React: Frontend framework
• MaterialUI: Component
• Tailwind: Styling
• ReduxToolkitQuery: State management and data fetching
• Express: Backend framework
• Typescript: Static typing
• TypeDI: Dependency injection
• MongoDB: Database
• Mongoose: ORM
• Agenda: Job scheduling
• Winston: Logging
• Zod: Validation

Getting Started

To set up Steex locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/LoganXav/Steex.git

2. Navigate to the backend directory:

   cd Steex/backend

3. Install dependencies:

   yarn

4. Start backend server:

   yarn dev

5. Navigate to the frontend directory:

   cd ../frontend

6. Install dependencies:

   yarn

7. Start frontend server:

   yarn dev

   Set environment variables in .env file based on both .env.example.