diff --git a/README.md b/README.md index 5b776fba9..7ad3a7367 100644 --- a/README.md +++ b/README.md @@ -23,24 +23,88 @@ > This project is currently under community review and will publish it's first production release soon™. ## Documenso + Signing documents digitally is fast, easy and should be best practice for every document signed worldwide. This is technically quite easy today, but it also introduces a new party to every signature: The signing tool providers. While this is not a problem in itself, it should make us think about how we want these providers of trust to work. Documenso aims to be the world's most trusted document signing tool. This trust is built by empowering you to self-host Documenso and review how it works under the hood. Join us in creating the next generation of open trust infrastructure. +## Community + +If you want to be part of Documenso you can: + +- Check out the first source code release in this repository +- Tell us what you think in the current [Discussions](https://github.com/documenso/documenso/discussions) +- Join the [Slack Channel](https://join.slack.com/t/documenso/shared_invite/zt-1qwxxsvli-nDyojjt~wakhgBGl9JRl2w) for any questions and getting to know to other community members +- ⭐ the repository to help us raise awareness +- Fix or create [issues](https://github.com/documenso/documenso/issues), that are needed for the first production release +- Spread the word on Twitter, that Documenso is working towards a more open signing tool + ## Tools - This repos uses 📝 https://gitmoji.dev/ for more expressive commit messages. -- Use 🧹 for quality of code (eg remove comments, debug output, remove unused code) +- Use 🧹 for quality of code (eg remove comments, debug output, remove unused code) -## Todos +# Tech -- Sendgrid setup and nodemailer-sendgrid SMTP hint (import for interchangeability like SMTP) -- Render Deploy YAML file or similar -- Create self signed cert step by step with recommendation for use and validity scope +Documenso is built using awesome open source tech including: -# Setup +- [Typescript](https://www.typescriptlang.org/) +- [Javascript (when neccessary)](https://developer.mozilla.org/en-US/docs/Web/JavaScript) +- [NextJS (JS Fullstack Framework)](https://nextjs.org/) +- [Postgres SQL (Database)](https://www.postgresql.org/) +- [Prisma (ORM - Object-relational mapping)](https://www.prisma.io/) +- [Tailwind CSS (Styling)](https://tailwindcss.com/) +- [Node SignPDF (Digital Signature)](https://github.com/vbuch/node-signpdf) +- [React-PDF for viewing PDFs](https://github.com/wojtekmaj/react-pdf) +- [PDF-Lib for PDF manipulation](https://github.com/Hopding/pdf-lib) +- Check out /packages.json and /apps/web/package.json for more +- Support for [opensignpdf (requires Java on server)](https://github.com/open-pdf-sign) is currently planned. -- Clone the repo: git clone https://github.com/ElTimuro/documenso +# Getting Started + +## Requirements + +To run Documenso locally you need + +- [Node.js (Version: >=18.x)](https://nodejs.org/en/download/) +- Node Package Manger NPM - included in Node.js +- [PostgreSQL (local or remote)](https://www.postgresql.org/download/) + +## Developer Setup + +Follow these steps to setup documenso on you local machnine: + +- Clone the repo: git clone https://github.com/documenso/documenso - Run npm i in root directory - Rename .env.example to .env -- Set DATABASE_URL and SENDGRID_API_KEY values in .env file +- Set DATABASE_URL value in .env file + - You can use the provided test database url (may be wiped at any point) + - Or setup a local postgres sql instance (recommened) +- Set SENDGRID_API_KEY value in .env file + - You need SendGrid account, which you can create [here](https://signup.sendgrid.com/). + - Documenso uses [Nodemailer](https://nodemailer.com/about/) so you can easily use your own smtp server - Run npm run dev root directory to start - Register a new user at http://localhost:3000/signup + +--- + +- Optional: Create your own signing certificate + - A demo certificate is provided in /app/web/ressources/certificate.p12 + - To generate you own using these steps and a linux Terminal or Windows Linux Subsystem see **Create your own signging certificate**. + +# Creating your own signging certificate + +For the digital signature of you documents you need a signign certificate in .p12 formate (public and private key). You can buy one (not recommended for dev) or use the steps to create a self-signed one: + +1. Generate a private key using the OpenSSL command. You can run the following command to generate a 2048-bit RSA key:\ + openssl genrsa -out private.key 2048 + +2. Generate a self-signed certificate using the private key. You can run the following command to generate a self-signed certificate:\ + openssl req -new -x509 -key private.key -out certificate.crt -days 365 \ + This will prompt you to enter some information, such as the Common Name (CN) for the certificate. Make sure you enter the correct information. The -days parameter sets the number of days for which the certificate is valid. +3. Combine the private key and the self-signed certificate to create the p12 certificate. You can run the following command to do this: \ openssl pkcs12 -export -out certificate.p12 -inkey private.key -in certificate.crt +4. You will be prompted to enter a password for the p12 file. Choose a strong password and remember it, as you will need it to use the certificate (**can be empty for dev certificates**) +5. Place the certificate /apps/web/ressource/certificate.p12 + +# Deploying - Coming Soon™ + +- Docker support +- One-Click-Deploy on Render.com Deploy \ No newline at end of file