mirror of
https://github.com/penxio/penx.git
synced 2026-04-19 03:03:06 -04:00
56 lines
971 B
Markdown
56 lines
971 B
Markdown
<div align="center">
|
|
|
|
<a href="https://www.penx.io" alt="PenX Logo">
|
|
<img src="https://www.penx.io/images/logo-512.png" height="120"/></a>
|
|
|
|
<h1 style="border-bottom: none">
|
|
<b>PenX</b><br />
|
|
A structured note-taking App.
|
|
<br>
|
|
</h1>
|
|
|
|
[Discord](https://discord.gg/nyVpH9njDu) | [Website](https://www.penx.io/) | [Issues](https://github.com/penxio/penx/issues)
|
|
|
|
</div>
|
|
|
|
## Introduction
|
|
|
|
An elegant App designed to help you capture, organize, and store your thoughts, tasks, ideas, and information
|
|
|
|
## Features
|
|
|
|
- Local-first
|
|
- Privacy-first
|
|
- Open source
|
|
- Cross platform
|
|
- Realtime sync
|
|
- Creator friendly
|
|
|
|
## Primary tech stack
|
|
|
|
- Next.js
|
|
- TypeScript
|
|
- tRPC
|
|
- Prisma
|
|
- Slate.js
|
|
- IndexedDB
|
|
|
|
## Development
|
|
|
|
## web
|
|
|
|
After clone the repo, in the root dir:
|
|
|
|
```bash
|
|
# Install the dependencies
|
|
pnpm install
|
|
|
|
# copy .env.local.example to .env.local copy
|
|
copy apps/web/.env.local.example apps/web/.env.local
|
|
|
|
# start web service
|
|
pnpm dev
|
|
```
|
|
|
|
## ⚖️ License
|