Privnote

Clearnet View · Tor View
Privnote is a secure, open source and zero javascript note sharing service inspired by PrivNote written in rust & svelte.
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgments

About The Project

Privnote is a secure, open-source note sharing service inspired by PrivNote. This project is unique because it's built with Svelte but emits zero JavaScript, ensuring a lightweight and fast user experience. The backend is powered by Axum, a highly performant web application framework.

Here's why you should consider using or contributing to Privnote:

• It's secure: Your notes are safe and can be shared confidently.
• It's efficient: With zero JavaScript emission from Svelte and a performant backend in Axum, Privnote is built for speed.
• It's open-source: This means you can contribute to its development, suggest changes, and help improve it.

Privnote is not just another note sharing service. It's designed to be secure, efficient, and user-friendly.

Built With

The major frameworks/libraries used to bootstrap this project include:

• Rust: A language empowering everyone to build reliable and efficient software.
• SvelteKit: A framework for building extremely high-performance web apps.
• SeaORM: An async, dynamic and lightweight ORM for Rust.
• Axum: A web application framework that ensures high performance.
• Svelte: A JavaScript framework for building user interfaces. In this project, it's configured to emit zero JavaScript.
• PostgreSQL: A powerful, open source object-relational database system.
• Tailwind CSS: A utility-first CSS framework for rapidly building custom designs.
• TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.

(back to top)

Getting Started

To get a local copy of Privnote up and running, follow these steps:

Prerequisites

• You need to have Rust installed. If you don't have it, you can install it from here.
• You need Node.js and npm installed. If you don't have them, you can install Node.js from here which includes npm.

Installation

1. Clone the repo

   git clone https://github.com/0-don/privnote.git
   

2. Change directory to the cloned repo

   cd privnote
   

3. Open a new terminal and start the server

   cd server && cargo run
   

4. Open a new terminal and start the Web App

   yarn
   yarn dev
   

(back to top)

Usage

Privnote is a secure, open-source note sharing service. You can use it to share notes securely with others. Simply write your note, generate a link, and share it. The note will self-destruct after being read.

Roadmap

See the open issues for a list of proposed features and known issues.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Project Link: https://github.com/0-don/privnote

Acknowledgments

• Svelte
• Axum
• SeaORM
• Rust
• Docker
• PostgreSQL
• SvelteKit
• Tailwind CSS
• TypeScript
• ESLint
• Prettier

(back to top)