LessonBlock

Explore the docs »

Live Site · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contact

About The Project

LessonBlock is an EdTech platform inspired by Khan Academy that allows instructors to create new video courses and students to enroll in those course.

Built With

• React.js
• Redux
• JavaScript
• Python
• Flask
• SQLAlchemy
• Alembic
• PostgreSQL
• TailwindCSS

Getting Started

To get started follow the following steps

Prerequisites

• PostgreSQL
• Pipenv with Python v3.8
• Node.js

Installation

1. git clone this repo
2. cd into the local repo
3. Run pipenv install -r --dev dev-requirements.txt && pipenv install -r requirements.txt
4. Create your own .env file based on the provided .env.example.
5. Create a user and database in your PostgreSQL that matches your .env configuration
6. In the first terminal, run pipenv shell to activate the Pipenv environment.
7. Run flask db upgrade and then flask seed all to apply migrations and seed data to your database.
8. Open another terminal window and cd into the local repo, then cd into react-app
9. Run npm install
10. In your terminal running pipenv shell, run flask run.
11. In your terminal in the react-app, run npm start.
12. Your app should open in your default browser.
13. If you are planning on developing, please make a fork and create pull requests as necessary.

Usage

Roadmap

Checkout The Planning At The Wiki Section

Live Site

LessonBlock Live

Connect with Me