Lesson Editor for LKK 🚀

Create and edit lessons for the Lær Kidsa Koding (LKK) website without any Git hassles!

🌐 Live Demo

Check out the live demo here

📌 Features

• Frontend: Developed using ReactJS with Semantic UI React theming
• Backend: Manages server services, database, and GitHub communication
• Thumbnailer: Captures screenshots of lessons when saved using Puppeteer

🚀 Quick Start

1. Prerequisites: Install Node Version Manager and Docker-Desktop

2. Development Setup: Before accessing the application, ensure you've followed the Development Setup to configure your environment properly

3. Node Version: Ensure NodeJS is installed using nvm use (correct version in ./.nvmrc)

4. Setup: Install the required dependencies using npm install

5. Database: Set up the database by executing docker-compose up --build

   • If running the DB for the first time, you need to set up tables using npm run migration:run

6. Build:

   • Build all services: npm run build:dev

7. Run:

   • Backend: npm run start:dev

8. 🌍 Access: Open http://localhost:4200/ and start editing!

🛠 Development Setup

1. Create a new OAuth app on GitHub
2. Create a .env file in the project's root and populate with necessary values found in .env.example

📦 Dependencies Overview

• Main Framework: The project is built with React and NestJS
• Database: We use TypeORMM with a PostgreSQL database.
• UI Library: The frontend UI is enhanced using Semantic UI React
• Utility Services: For screenshots, we use Puppeteer

You can refer to the package.json file for the complete list and versions of dependencies and scripts

🤝 Contribution

Feel free to submit pull requests, create issues, and enhance the application. Every contribution is valued!

🔐 License

This project is licensed under the MIT License