README.md

ByteNotes

The open-source notes making application with features like collaboration in real time and much more.
Learn more »

Introduction · Features · Tech Stack · Self-hosting · Contributing

Introduction

ByteNotes is the open-source notes management infrastructure for modern teams and individuals.

Features

• Advanced Analytics
• Branded Links
• QR Codes
• Personalization
• Team Collaboration

Tech Stack

• Next.js – framework
• TypeScript – language
• Tailwind – CSS
• Upstash – redis // We will be adding it soon as requirement comes
• Postgres – database // Spinning up the docker container would be recommended locally
• Vercel – deployments
• cloudinary - Media management

Self-Hosting

You can self-host ByteNotes for greater control over your data and design.

Contributing

We love our contributors! Here's how you can contribute:

• Open an issue if you believe you've encountered a bug.
• Follow the local development guide to get your local dev environment set up.
• Make a pull request to add new features/make quality-of-life improvements/fix bugs.

For Local Development (with existing PostgreSQL)

1. Copy .env.example to .env and update with your local PostgreSQL and Cloudinary credentials.
2. Update the DATABASE_URL in docker-compose.yml to use host.docker.internal instead of db.
3. Run docker-compose -f docker/docker-compose.yml up --build

For Remote Users or Fresh Setup

1. Copy .env.example to .env and update with your Cloudinary credentials.
2. Run docker-compose -f docker/docker-compose.yml up --build

The app will be available at http://localhost:3000