Skip to content

FilipElznic/LearningApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jul 24, 2025
3abdf61 · · Jul 24, 2025

History

67 Commits
Jul 24, 2025
Jul 22, 2025

Repository files navigation

🚀 Cosmic Learning App

Complete setup guide for the Cosmic Learning App. Follow these steps to get your space academy up and running!

âš ï¸ Prerequisites

Before you begin, ensure you have the following installed:

Requirement Version Description
Node.js 18+ Required for running the development server
Git Latest For cloning the repository and version control
Code Editor Any VS Code recommended with React extensions

ðŸ—„ï¸ Step 1: Supabase Database Setup

Why Supabase?

This project requires a Supabase database to handle:

  • User authentication
  • Store learning progress
  • Track XP points
  • Manage task completion

Supabase provides a powerful PostgreSQL database with real-time capabilities and built-in authentication.

Setup Steps:

  1. Create Account: Go to supabase.com and create a free account
  2. New Project: Create a new project and choose a region close to your users
  3. Get Credentials: Copy your project URL and anon key from Settings → API
  4. Database Schema: Insert the required database schema (see database.webp reference in assets folder)

âš ï¸ Important Note: You'll need to turn off RLS policies which is not recommended for production. Create your own policies for select, insert, update operations.


📦 Step 2: Clone Repository & Install Dependenciescies

Clone the Repository

git clone https://github.com/FilipElznic/LearningApp.git

cd LearningApp

Install Required Libraries

Core Dependencies:

npm install react react-dom react-router-dom
npm install @supabase/supabase-js
npm install lucide-reactct

Styling & UI: UI:

npm install tailwindcss postcss autoprefixer
npm install @splinetool/react-splinee

Development Tools:

npm install -D vite @vitejs/plugin-react
npm install -D eslint eslint-plugin-reactt

Or install everything at once:

npm install

âš™ï¸ Step 3: Environment Configuration

Create a .env file in the root directory:

VITE_SUPABASE_URL=your_supabase_project_url

VITE_SUPABASE_ANON_KEY=your_supabase_anon_key

🔒 Security Warning: Never commit your .env file to version control. Add it to .gitignore!


🚀 Step 4: Launch Your Cosmic Academy

Start Development Server

npm run dev

This will start the development server at http://localhost:5173

Build for Production

npm run build

Creates an optimized production build in the dist folder


✨ Features Overview

🔠User Authentication

  • Secure login/signup with Supabase Auth

â­ XP System

  • Earn points based on difficulty levels

📈 Progress Tracking

  • Monitor learning journey and achievements

🎮 Interactive UI

  • Engaging space-themed interface

🌠Multiple Realms

  • Earth, Moon, and Deep Space challenges

🆠Leaderboards

  • Compete with fellow space explorers

ðŸ› ï¸ Tech Stack

  • Frontend: React, Vite
  • Styling: Tailwind CSS
  • Database: Supabase (PostgreSQL)
  • Authentication: Supabase Auth
  • 3D Elements: Spline
  • Icons: Lucide React
  • Routing: React Router DOM

📠Project Structure

LearningApp/
├── src/
│   ├── assets/
│   ├── components/
│   ├── pages/
│   └── App.css
│   └── App.jsx
│   └── AuthContext.jsx
│   └── index.css
│   └── main.jsx
│   └── supabaseClient.js
│   └── ToastContext.jsx
├── public/
├── .env
├── package.json
├── tailwind.config.js
└── vite.config.js
 vite.config.js

---

Ready to explore the cosmos of learning? 🌌