A fun and interactive learning platform with an elephant mascot that helps you study effectively.
- Welcome Screen: Beautiful landing page with Remi logo
- Login/Signup: Secure authentication with Google OAuth integration
- Home Screen: Main hub with project navigation
- Projects Screen: View all your projects with schedule and course materials
- Document Upload: Upload PDF course materials and schedule files
- Loading Screen: Animated loading with progress messages
- Dashboard: Analytics and insights with interactive charts
- Install dependencies:
npm install-
Configure Environment Variables:
Create a
.envfile in the root directory:REACT_APP_API_URL=http://localhost:3001 REACT_APP_GOOGLE_CLIENT_ID=982461567045-hevqk983sihfm8s266vuaojvvql83m51.apps.googleusercontent.com
Replace
http://localhost:3001with your actual API server URL.Note: The Google OAuth Client ID is already configured. The CLIENT_SECRET should only be used on your backend server, never in the frontend.
-
Add your images to the
publicfolder (if not already present):remi.png- Remi logoelephant1.png- Elephant mascot for welcome screenelephant2.png- Elephant mascot for upload screenelephant3.png- Elephant mascot for dashboard (alternating)elephant4.png- Elephant mascot for done screen
-
Start the development server:
npm startThe app integrates with a user authentication API. Make sure your backend API is running and accessible at the URL specified in your .env file.
POST /register- Register a new userPOST /signin- Sign in an existing userPOST /auth- Link Google OAuth account
- Email/password authentication
- Google OAuth sign-in
- Error handling for invalid credentials
- User ID storage in localStorage
- Automatic redirection after successful login/signup
- Beige: #F5F5DC (background)
- Navy Blue: #1a1a4a (accents, buttons)
- Welcome Screen - Landing page with logo and get started button
- Login/Signup - Working authentication with API integration and Google OAuth
- Home Screen - Main hub with logo and navigation options
- Projects Screen - View all your projects with schedule and course materials
- Upload Screen - Document upload interface
- Loading Screen - Progress indicator
- Done Screen - Completion confirmation
- Dashboard - Analytics and metrics
- React 18
- React Router DOM
- Recharts (for analytics)
- Google Identity Services (OAuth)
- CSS3 (with animations and glass morphism effects)
The app includes Google OAuth integration for easy sign-in. See README_GOOGLE_OAUTH.md for detailed setup instructions.