Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 2.43 KB

README.md

File metadata and controls

45 lines (31 loc) · 2.43 KB

LearnTube - Unlock the Power of YouTube Learning with Our Course-Boosting App! 👩‍🎓

WhatsApp Image 2023-04-09 at 11 23 37

About 🚀

LearnTube is a free online education app that allows learners to access high-quality course playlists on YouTube and track their progress with an analysis dashboard. The app provides learners with data on their learning progress, including time spent on each video, quiz scores, and overall progress. This analysis helps learners stay motivated and accountable for their learning goals.

Features ✨

  • Seamless onboarding experience for users
  • Courses divided into categories for easy browsing and enrollment
  • Analysis graphs with a dashboard for tracking learning progress
  • Personalized course recommendations based on learners' interests and learning styles (coming soon)
  • Social features for connecting with other learners and sharing progress

Technologies Used 💻

  • React for the front-end
  • Node.js for the back-end
  • YouTube's API for course playlist integration and video/channel data retrieval

Getting Started 👋

To run the app locally, you'll need to have Node.js and Git installed on your machine. Once you have these installed, follow these steps:

  1. Clone this repo using git clone https://github.com/OMGATE/learntube.git
  2. Navigate to the cloned repo using cd learntube/client
  3. Install the necessary dependencies using npm install
  4. Create a .env file in the root directory and add your YouTube API key. You can obtain an API key by following the instructions here.
  5. Start the app using npm start
  6. Navigate to http://localhost:3000 to view the app in your browser

Contributing 🤝

We welcome contributions from the community! To contribute to the project, please follow these steps:

  1. Fork this repo
  2. Create a new branch for your feature/bug fix using git checkout -b my-feature-branch
  3. Make your changes and commit them using git commit -m "my commit message"
  4. Push your changes to your fork using git push origin my-feature-branch
  5. Submit a pull request to the main repo and wait for review and approval

License 🛡

This app is licensed under the MIT License. See the LICENSE file for more information.