Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 3.05 KB

README.md

File metadata and controls

62 lines (45 loc) · 3.05 KB

leARn 🚀

Augmented Education Without Boundaries, Where Every Mind Matters.

React Firebase Node.js HTML5 CSS3 AR OpenCV Machine Learning Tailwind CSS Unity Google Cloud Docker Cloud Vision API Cloud Build ARCore

Overview

Welcome to our Learning Platform, which utilizes Virtual Reality (VR) and Machine Learning (ML) technologies to provide an immersive and personalized learning experience. At leARn, we are revolutionizing education through the power of augmented reality by making education more engaging, interactive, and accessible, we are contributing to the overall goal of ensuring inclusive and equitable quality education for all.

Usage 🛠️

Frontend Setup 🖥️

  1. Clone the repository to your local machine and get into directory.

    git clone https://github.com/gamandeepsingh/learn
    cd leARn
  2. Install the required packages.

    npm install
  3. Start the development server.

    npm start
  4. Open the project in your browser at http://localhost:3000 to view your project.

  5. Create your React components and add your styles using Tailwind CSS classes. You can also create new CSS files and import them into your components.

  6. The project is set up to use postcss-cli to process your CSS files. You can add your own tailwind.config.js file to customize your Tailwind setup.

Backend Setup (Firebase) 🔥

  1. Set up Firebase for your project by following the Firebase documentation.

  2. Configure Firebase credentials in your project.

  3. Install Firebase tools globally.

    npm install firebase
  4. Your backend is now live on Firebase, and you can interact with it from your frontend.