Skip to content

BrightBoost-Tech/Bright-Bots-Setup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bright Bots Learn - EdTech MVP Setup

This repository contains automation scripts to set up and deploy the Bright Bots Learn EdTech MVP, a platform designed to make STEM learning fun and accessible for K-2 learners.

Contents

  • setup-frontend.sh: Script to set up the React frontend with Material-UI
  • setup-backend.sh: Script to set up the Node.js/Express backend with MongoDB
  • setup-deployment.sh: Script to set up deployment options for various cloud platforms
  • implementation-roadmap.md: Comprehensive guide for implementing the full MVP

Getting Started

  1. Clone this repository to your local machine:

    git clone https://github.com/your-username/bright-bots-setup.git
    cd bright-bots-setup
  2. Make all scripts executable:

    chmod +x setup-frontend.sh setup-backend.sh setup-deployment.sh
  3. Follow the implementation roadmap:

    cat implementation-roadmap.md

Setup Process

1. Frontend Setup

Run the frontend setup script to create a React application with Material-UI components:

./setup-frontend.sh

This will create a bright-bots-client directory with a complete React application.

2. Backend Setup

Run the backend setup script to create a Node.js/Express API with MongoDB:

./setup-backend.sh

This will create a bright-bots-server directory with a complete Express application.

3. Deployment Setup

Run the deployment setup script to create deployment options for various cloud platforms:

./setup-deployment.sh

This will create a bright-bots-deploy directory with deployment scripts for Heroku, AWS, and DigitalOcean.

Project Features

  • Child-friendly UI: Large buttons, bright colors, minimal text
  • Interactive Elements: Drag-and-drop, matching games, and more
  • Progress Tracking: Stars, badges, and completion bars
  • User Management: Sign up, sign in, teacher/student roles
  • Lesson Management: STEM modules for K-2 learners
  • Teacher Dashboard: Class roster, lesson assignment, analytics

Next Steps

After setting up the project, refer to the implementation roadmap for detailed instructions on:

  • Customizing the frontend and backend
  • Connecting to a database
  • Testing the application
  • Deploying to a cloud platform

Support

If you encounter any issues during setup, please check the logs in the respective directories or refer to the documentation for the specific technologies used (React, Node.js, MongoDB).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages