Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aniraannu/uplearn
Uplearn is an interactive learning platform where users can browse, enroll in, and complete skill-based courses.
https://github.com/aniraannu/uplearn
Last synced: about 2 months ago
JSON representation
Uplearn is an interactive learning platform where users can browse, enroll in, and complete skill-based courses.
- Host: GitHub
- URL: https://github.com/aniraannu/uplearn
- Owner: aniraannu
- Created: 2024-09-06T03:39:52.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-18T04:17:04.000Z (4 months ago)
- Last Synced: 2024-09-19T01:46:26.916Z (4 months ago)
- Language: JavaScript
- Size: 4.54 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Uplearn
Welcome to Uplearn! Uplearn is an innovative e-learning platform designed to provide personilized learning experience for users across various application, Uplearn offers interactive courses, real-time progress tracking, and a dynamic content delivery system. It is a full-stack e-learning platform designed to provide a seamless learning experience with modern web technologies. This project leverages Node.js, MongoDB, Mongoose, JWT, React, and GraphQL, and is deployed using Render.
## Table of Contents
Description
Features
Technologies
Getting Started
Setup and Installation
Configuration
Usage
Testing
Deployment
Contributing
License
Acknowledgements
## Description
Uplearn is an interactive learning platform where users can browse, enroll in, and complete skill-based courses. The platform integrates user-friendly interfaces with backend scalability, ensuring seamless access to educational materials, assesments, and a collaborative learning tools. Uplearn aims to empower learners with flexible, on-demand education tailored to their pace and learning style, making knowledge more accessible and engaging to all.
## Features
* User authentication with JWT
* GraphQL API for flexible queries and mutations
* Responsive front-end built with React
* Data persistence with MongoDB and Mongoose ODM
* Full-stack architecture with Node.js and Express.js
* Deployment on Render for high availability
### Technologies
Back-end:
* Node.js
* Express.js
* MongoDB
* Mongoose ODM
* GraphQL
Front-end:
* React
Authentication:
* JWT (JSON Web Token)
Deployment:
*Render
## Getting Started
To get started with Uplearn, follow these steps to set up the development environment.
### Prerequisites
* Node.js (v14.x or later)
* MongoDB (local or remote instance)
* NPM or Yarn (for managing packages)
### Installing
* Clone the repository:
git clone https://github.com/aniraannu/uplearn.git
cd uplearn
* Install the dependencies for both client and server
* Set up environment variables:
Create a .env file in the backend directory and add your MongoDB connection string and JWT secret:
MONGODB_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret
* Start the development server
### Usage
* Navigate to http://localhost:3000 in your browser to access the Uplearn frontend.
* The backend API will be running on http://localhost:5000.
## Deployment
Uplearn is deployed using Render. To deploy your own instance, follow these steps:
* Push your code to a Git repository.
* Connect your repository to Render.
* Set up build and start commands for both frontend and backend.
* Configure environment variables in Render.
## Contributing
We welcome contributions to Uplearn! If you have suggestions or improvements, please follow these steps:
* Fork the repository.
* Create a new branch for your changes.
* Commit your changes and push the branch to your fork.
* Open a pull request describing your changes.
## Help
NA
## Authors
Contributors names and contact info
* Amrinderjeet Kaur
[@AJKaur]https://github.com/AJKaur02
* Anira Raveendran
[@aniraannu](https://github.com/aniraannu)
* Jose Arambula
[@daimyo1]https://github.com/daimyo1
* Robel
[@Robel11A]https://github.com/Robel11A
* Saima Yunus
[@saimayunus925]https://github.com/saimayunus925
* Urie Williams
[@urie-w]https://github.com/urie-w
## Version History
* 0.1
* Initial Release
## License
None
## Acknowledgments
Inspiration, code snippets, etc.
* [dbader](https://github.com/dbader/readme-template)