https://github.com/bhanu-code/openlms
open source learning management system for institutions
https://github.com/bhanu-code/openlms
formik gssoc gssoc-ext lms nextjs nextjs14 react-query redux-toolkit saas shadcn-ui tailwindcss typescript
Last synced: 8 months ago
JSON representation
open source learning management system for institutions
- Host: GitHub
- URL: https://github.com/bhanu-code/openlms
- Owner: Bhanu-code
- License: mit
- Created: 2024-05-08T06:58:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-13T08:32:34.000Z (12 months ago)
- Last Synced: 2025-02-13T09:31:26.631Z (12 months ago)
- Topics: formik, gssoc, gssoc-ext, lms, nextjs, nextjs14, react-query, redux-toolkit, saas, shadcn-ui, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://theopenlms.netlify.app/
- Size: 1.77 MB
- Stars: 11
- Watchers: 2
- Forks: 8
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github?af=5236ad)
## Table of Contents
1. [Introduction](#introduction)
2. [Tech Stack](#tech-stack)
3. [Features](#features)
4. [Web Screens](#screens)
5. [Installation Guide](#installation-guide)
6. [Contributing Guide](#contributing-guide)
7. [Outreach](#outreach)
8. [Project Admin](#project-admin)
9. [Code of Conduct](#code-of-conduct)
10. [Learn More](#learn-more)
11. [Deploy on Vercel](#deploy-on-vercel)
12. [License](#license)
13. [Support](#support)
14. [Contributors](#contributors)
15. [Design Links](#design)
## ✨🎈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](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](https://github.com/Bhanu-code/OpenLMS/blob/master/CODE_OF_CONDUCT.md). 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](https://nextjs.org/docs)** - Explore Next.js features and API.
- **[Learn Next.js](https://nextjs.org/learn)** - Engage with an interactive tutorial to enhance your skills.
- **[Next.js GitHub Repository](https://github.com/vercel/next.js)** - 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](https://nextjs.org/docs/deployment).
## 📝License
Gityzer is licensed under the terms of the MIT License. check out LICENSE for details. ![]()
## ⭐Support
- 💰 Become our [Sponsor](https://github.com/sponsors/OpenLMS)!
- ⭐ Star our Repo
## Contributors
# 🫱🏼🫲🏼Big thanks to all the contributors! 🫱🏼🫲🏼
## 🔗Design Links
1. https://www.figma.com/design/7WFQvDENPrc7fYdeOmx3yV/Login-Register?node-id=1669-162202&m=dev&t=APzuRtzGaWhOuRw9-1