SyncReads is a fully open source app which can be used to sync the newest articles and feeds into reMarkable tablet. The focus is primarily on producing the best workflow to consume web content on your offline devices. Feel free to open an issue or directly make a pull request. Enjoy!
Please read CONTRIBUTING.md
For more details look at Architecture details
| Tech | Description |
|---|---|
| TypeScript | Static type-checking programming language |
| Nest.js | Node.js framework for building efficien and scalable server-side applications |
| Next.js | React Framework for Production |
| React | Library for building user interfaces |
| tRPC | Library for building fully typesafe APIs |
| Docker | Open platform for developing, shipping, and running applications |
| Supabase | Open source Firebase alternative |
| PostgreSQL | Relational database |
| Vitest | Testing framework |
| shadcn/ui | Extendable component library |
| Tailwind | Utility-first CSS framework |
| React Hook Form | Forms with easy-to-use validation |
| Turborepo | High-performance build system for JavaScript and TypeScript codebases. |
| Husky | Git hooks |
| ESLint | TypeScript linting |
| Prettier | Code formatter |
- Node.js v20.*
- Docker + docker compose
git clone https://github.com/Bartek532/syncreads.git
pnpm install
cp .env.example .env
# set up environment variables
pnpm run db:setup:dev
pnpm run dev