cernockyd / scrapbook

KISK Scrapbook

Scrapbook (scrapbook.kisk.cz) is the place where we share our learning journey. The goal of the scrapbook is to create a place where we will enjoy coming back to find out what others are working on and support each other.

Project structure

The project is a monorepo containing following workspaces:

apps:

• site - Next.js app for the public website
• crawler - App for crawling study blogs for new content and analysis
• analyser - App for generating metadata for study blog posts (such as tags, etc.)
• importer - App for importing student profiles based on questionnares (such as tags, etc.)
• discord-bot - Discord bot for posting new content to discord, collecting reactions etc.

packages:

• db - Database schema, migrations and connection
• shared - Shared code between apps such as types, etc. There is also an old database connection that is still used in some places.
• tsconfig - Shared typescript configuration

Get started

1. install dependencies

npm i

2. set environmental variables

cp .env.example .env.local

3. run local site development server

npm run dev-site

Updating database schema

1. login to supabase

npx supabase login

2. download typings for the latest database schema

npm run type-gen

Origin of Scrapbook

Significant parts of the project are copied from, derived from, or inspired by Hack Club’s Scrapbook which is released under MIT License.#