Skip to content

AmandaKwok28/Kernel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kernel

Platform Electron React TypeScript Python Status

Kernel is a customizable desktop notebook that sits somewhere between VsCode editor and jupyter notebook. Built this because I don't like notion's color scheme and VsCode is great but not for notes. I love notion, but the color scheme and font aren't as nice as the github dark plugins you can get on VsCode.


Getting Started

Prereqs

  • Node.js (LTS recommended)
  • pnpm
  • Python 3.10+ (for the execution layer)

Install

Clone the repo and install dependencies in both the backend and frontend.

# backend
cd api
pnpm install

# frontend
cd ../web
pnpm install

Additionally, rename the .env.example file to .env in the web directory.

cd web
cp .env.example .env

Running the Application

# backend
cd api
pnpm run start          # in terminal 1 (will create the database if one doesn't exist already)

# frontend
cd web
pnpm dev                # in terminal 2
pnpm electron           # in terminal 3

About

A desktop notebook app for markdown-based notes with executable code blocks, built for technical thinking and reproducible workflows.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors