Table of Contents

1. Introduction
2. Tech Stack
3. Features
4. Web Screens
5. Installation Guide
6. Contributing Guide
7. Outreach
8. Project Admin
9. Code of Conduct
10. Learn More
11. Deploy on Vercel
12. License
13. Support
14. Contributors
15. Design Links

✨🎈Introduction

OpenLMS is an open-source learning management system (LMS) built using Next.js, a popular React framework. It provides institutions with a comprehensive platform to manage online learning activities effectively. With features like course creation, video conferencing, discussion forums, and file sharing, OpenLMS aims to be a user-friendly and scalable solution for educational institutions.

⌨️Tech Stack

• Next.js – React framework for server-side rendering and static site generation.
• Redux – State management.
• Formik – Form handling and validation.
• Shadcn/UI – UI components for consistent design.
• TypeScript – Static typing for better development experience.
• React-query – Server state management and data fetching.
• TailwindCSS – Utility-first CSS framework for styling.

💻Features

• User-friendly interface for creating and managing courses, assignments, and assessments.
• Integrated video conferencing for live classes and meetings.
• Discussion forums for students and instructors to collaborate and share ideas.
• File sharing for submitting assignments and sharing resources.
• Customizable to suit the needs of different institutions.
• Scalable to support institutions of all sizes.

🖼Web Screens

1. Login Screen:

2. Signup Screen:

🧑🏻‍💻Installation Guide

1. Clone this repository to your local machine:

   git clone https://github.com/your-username/OpenLMS.git
   cd ai-content-generator
   

2. Install the required dependencies:

   npm install 
   

3. Setup environment variables Create a .env.local file in the root directory and add the following values:

   SOCKET_IO_SERVER_URL=http://localhost:3001
   

4. Run the application For development:

npm run dev

For production:

npm run build
npm start

🛠️ Contributing Guide

We welcome contributions to the OpenLMS project! To contribute:

1. Fork the repository
2. Create a feature branch (git checkout -b feature-name)
3. Commit your changes (git commit -am 'Add new feature')
4. Push to the branch (git push origin feature-name)
5. Create a new Pull Request

Please refer to the CONTRIBUTING.md for more detailed information.

💪 Outreach

HelpOps-Hub is proudly part of global initiatives engaging with passionate developers and open-source enthusiasts worldwide:

Name	Logo	Purpose
GSSoC'2024-Extd		The coding period is from October 1st to October 30th, during which contributors make contributions and earn points on the platform.
Hacktoberfest 2024		Hacktoberfest is a month-long October event welcoming all skill levels to join the open source community, contribute quality pull requests on GitHub, and earn cool swag.

Project Admin

📑Code Of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

📚 Learn More

To deepen your understanding of Next.js, check out these valuable resources:

• Next.js Documentation - Explore Next.js features and API.
• Learn Next.js - Engage with an interactive tutorial to enhance your skills.
• Next.js GitHub Repository - Your feedback and contributions are always welcome!

🌐 Deploy on Vercel

The simplest way to deploy your Next.js app is through the Vercel Platform, created by the team behind Next.js. For more deployment options, refer to our Next.js deployment documentation.

📝License

Gityzer is licensed under the terms of the MIT License. check out LICENSE for details.

⭐Support

• 💰 Become our Sponsor!

• ⭐ Star our Repo

  Contributors

  🫱🏼‍🫲🏼Big thanks to all the contributors! 🫱🏼‍🫲🏼

(Back to top⬆️)

🔗Design Links

1. https://www.figma.com/design/7WFQvDENPrc7fYdeOmx3yV/Login-Register?node-id=1669-162202&m=dev&t=APzuRtzGaWhOuRw9-1