Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeremy-code/inkhorn

next-gen assistant for students
https://github.com/jeremy-code/inkhorn

nextjs open-source students study tools typescript

Last synced: 5 days ago
JSON representation

next-gen assistant for students

Awesome Lists containing this project

README

        

# inkhorn [![GitHub Actions badge](https://github.com/jeremy-code/inkhorn/actions/workflows/ci.yml/badge.svg)](https://github.com/jeremy-code/inkhorn/actions/workflows/ci.yml) [![License](https://img.shields.io/github/license/jeremy-code/inkhorn)](LICENSE)

> inkhorn is an open-source next-gen notetaking web app for students. Built with [Next.js](https://nextjs.org), [Drizzle ORM](https://orm.drizzle.team), [Panda CSS](https://panda-css.com), [Ark UI](https://ark-ui.com), and [Neon](https://neon.tech/). Hosted on [Vercel](https://vercel.com).

## 🛠️ Installation

```bash
git clone https://github.com/jeremy-code/inkhorn.git
cd inkhorn
corepack enable
yarn
```

## 🚀 Usage

```bash
# Set Node.js version
nvm use

# Run the development server locally
yarn dev

# Run any scripts
yarn tsx scripts/.ts

# Lint and format code
yarn lint
yarn format

# Build
yarn build
```

## 🔓 License

This project is licensed under the [MIT license](LICENSE).