diff --git a/.devcontainer/on-create.sh b/.devcontainer/on-create.sh index a66491ef7..fbd5351f2 100755 --- a/.devcontainer/on-create.sh +++ b/.devcontainer/on-create.sh @@ -9,10 +9,5 @@ npm install # Copy the env file cp .env.example .env -# Source the env file, export the variables -set -a -source .env -set +a - # Run the migrations -npm run -w @documenso/prisma prisma:migrate-dev +npm run prisma:migrate-dev diff --git a/.env.example b/.env.example index 065976bc5..7bd71c04b 100644 --- a/.env.example +++ b/.env.example @@ -15,6 +15,11 @@ NEXT_PRIVATE_DATABASE_URL="postgres://documenso:password@127.0.0.1:54320/documen # Defines the URL to use for the database when running migrations and other commands that won't work with a connection pool. NEXT_PRIVATE_DIRECT_DATABASE_URL="postgres://documenso:password@127.0.0.1:54320/documenso" +# [[E2E Tests]] +E2E_TEST_AUTHENTICATE_USERNAME="Test User" +E2E_TEST_AUTHENTICATE_USER_EMAIL="testuser@mail.com" +E2E_TEST_AUTHENTICATE_USER_PASSWORD="test_password" + # [[STORAGE]] # OPTIONAL: Defines the storage transport to use. Available options: database (default) | s3 NEXT_PUBLIC_UPLOAD_TRANSPORT="database" @@ -68,6 +73,7 @@ NEXT_PRIVATE_STRIPE_API_KEY= NEXT_PRIVATE_STRIPE_WEBHOOK_SECRET= NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_MONTHLY_PRICE_ID= NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_YEARLY_PRICE_ID= +NEXT_PUBLIC_STRIPE_FREE_PLAN_ID= # [[FEATURES]] # OPTIONAL: Leave blank to disable PostHog and feature flags. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..f5fdb5166 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,47 @@ +name: "Bug Report" +labels: "bug" +description: Create a bug report to help us improve +body: + - type: markdown + attributes: + value: + Thank you for reporting an issue. + Please fill in as much of the form below as you're able to. + - type: textarea + attributes: + label: Issue Description + description: Please provide a clear and concise description of the problem. + - type: textarea + attributes: + label: Steps to Reproduce + description: Please provide step-by-step instructions to reproduce the issue. Include code snippets, error messages, and any other relevant information. + - type: textarea + attributes: + label: Expected Behavior + description: Describe what you expected to happen. + - type: textarea + attributes: + label: Current Behavior + description: Describe what is currently happening. + - type: textarea + attributes: + label: Screenshots (optional) + description: If applicable, add screenshots to help explain the issue. + - type: input + attributes: + label: Operating System [e.g., Windows 10] + - type: input + attributes: + label: Browser [e.g., Chrome, Firefox] + - type: input + attributes: + label: Version [e.g., 2.0.1] + - type: checkboxes + attributes: + label: Please check the boxes that apply to this issue report. + options: + - label: I have searched the existing issues to make sure this is not a duplicate. + - label: I have provided steps to reproduce the issue. + - label: I have included relevant environment information. + - label: I have included any relevant screenshots. + - label: I understand that this is a voluntary contribution and that there is no guarantee of resolution. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..f323f9475 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,35 @@ +name: "Feature Request" +description: Suggest a new idea or enhancement for this project +body: + - type: markdown + attributes: + value: Please provide a clear and concise title for your feature request + - type: textarea + attributes: + label: Feature Description + description: Describe the feature you are requesting in detail. Explain what problem it solves or what value it adds to the project. + - type: textarea + attributes: + label: Use Case + description: Provide a scenario or use case where this feature would be beneficial. Explain how users would interact with this feature and why it's important. + - type: textarea + attributes: + label: Proposed Solution + description: If you have an idea of how this feature could be implemented, describe it here. Include any technical details, UI/UX considerations, or design suggestions. + - type: textarea + attributes: + label: Alternatives (optional) + description: Are there any alternative ways to achieve the same goal? Describe other approaches that could be considered if this feature is not implemented. + - type: textarea + attributes: + label: Additional Context + description: Add any additional context or information that might be relevant to the feature request. + - type: checkboxes + attributes: + label: Please check the boxes that apply to this feature request. + options: + - label: I have searched the existing feature requests to make sure this is not a duplicate. + - label: I have provided a detailed description of the requested feature. + - label: I have explained the use case or scenario for this feature. + - label: I have included any relevant technical details or design suggestions. + - label: I understand that this is a suggestion and that there is no guarantee of implementation. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/improvement.yml b/.github/ISSUE_TEMPLATE/improvement.yml new file mode 100644 index 000000000..bebcb4cb5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement.yml @@ -0,0 +1,35 @@ +name: "General Improvement" +description: Suggest a minor enhancement or improvement for this project +body: + - type: markdown + attributes: + value: Please provide a clear and concise title for your improvement suggestion + - type: textarea + attributes: + label: Improvement Description + description: Describe the improvement you are suggesting in detail. Explain what specific aspect of the project it addresses or enhances. + - type: textarea + attributes: + label: Rationale + description: Explain why this improvement would be beneficial. Share any context, pain points, or reasons for suggesting this change. + - type: textarea + attributes: + label: Proposed Solution + description: If you have a suggestion for how this improvement could be implemented, describe it here. Include any technical details, design suggestions, or other relevant information. + - type: textarea + attributes: + label: Alternatives (optional) + description: Are there any alternative approaches to achieve the same improvement? Describe other ways to address the issue or enhance the project. + - type: textarea + attributes: + label: Additional Context + description: Add any additional context or information that might be relevant to the improvement suggestion. + - type: checkboxes + attributes: + label: Please check the boxes that apply to this improvement suggestion. + options: + - label: I have searched the existing issues and improvement suggestions to avoid duplication. + - label: I have provided a clear description of the improvement being suggested. + - label: I have explained the rationale behind this improvement. + - label: I have included any relevant technical details or design suggestions. + - label: I understand that this is a suggestion and that there is no guarantee of implementation. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/generic.md b/.github/PULL_REQUEST_TEMPLATE/generic.md new file mode 100644 index 000000000..70b668b5c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/generic.md @@ -0,0 +1,49 @@ +--- +name: Pull Request +about: Submit changes to the project for review and inclusion +--- + +## Description + + + + +## Related Issue + + + + +## Changes Made + + + + +- Change 1 +- Change 2 +- ... + +## Testing Performed + + + + +- Tested feature X in scenario Y. +- Ran unit tests for component Z. +- Tested on browsers A, B, and C. +- ... + +## Checklist + + + + +- [ ] I have tested these changes locally and they work as expected. +- [ ] I have added/updated tests that prove the effectiveness of these changes. +- [ ] I have updated the documentation to reflect these changes, if applicable. +- [ ] I have followed the project's coding style guidelines. +- [ ] I have addressed the code review feedback from the previous submission, if applicable. + +## Additional Notes + + + diff --git a/.github/PULL_REQUEST_TEMPLATE/test-addition.md b/.github/PULL_REQUEST_TEMPLATE/test-addition.md new file mode 100644 index 000000000..f93c81493 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/test-addition.md @@ -0,0 +1,40 @@ +--- +name: Test Addition +about: Submit a new test, either unit or end-to-end (E2E), for review and inclusion +--- + +## Description + + + + +## Related Issue + + + + +## Test Details + + + + +- Test Name: Name of the test +- Type: [Unit / E2E] +- Description: Brief description of what the test checks +- Inputs: What inputs the test uses (if applicable) +- Expected Output: What output or behavior the test expects + +## Checklist + + + + +- [ ] I have written the new test and ensured it works as intended. +- [ ] I have added necessary documentation to explain the purpose of the test. +- [ ] I have followed the project's testing guidelines and coding style. +- [ ] I have addressed any review feedback from previous submissions, if applicable. + +## Additional Notes + + + diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 74fcb319b..1269fd6c5 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -9,7 +9,7 @@ updates: labels: - "ci dependencies" - "ci" - open-pull-requests-limit: 2 + open-pull-requests-limit: 0 - package-ecosystem: "npm" directory: "/apps/marketing" @@ -19,7 +19,7 @@ updates: labels: - "npm dependencies" - "frontend" - open-pull-requests-limit: 2 + open-pull-requests-limit: 0 - package-ecosystem: "npm" directory: "/apps/web" @@ -29,4 +29,4 @@ updates: labels: - "npm dependencies" - "frontend" - open-pull-requests-limit: 2 + open-pull-requests-limit: 0 diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml new file mode 100644 index 000000000..8f0e7bb19 --- /dev/null +++ b/.github/workflows/e2e-tests.yml @@ -0,0 +1,51 @@ +name: Playwright Tests +on: + push: + branches: [feat/refresh] + pull_request: + branches: [feat/refresh] +jobs: + e2e_tests: + timeout-minutes: 60 + runs-on: ubuntu-latest + services: + postgres: + image: postgres + env: + POSTGRES_USER: postgres + POSTGRES_PASSWORD: postgres + options: >- + --health-cmd pg_isready + --health-interval 10s + --health-timeout 5s + --health-retries 5 + ports: + - 5432:5432 + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 18 + - name: Install dependencies + run: npm ci + - name: Copy env + run: cp .env.example .env + - name: Install Playwright Browsers + run: npx playwright install --with-deps + - name: Generate Prisma Client + run: npm run prisma:generate -w @documenso/prisma + - name: Create the database + run: npm run prisma:migrate-dev + - name: Run Playwright tests + run: npm run ci + - uses: actions/upload-artifact@v3 + if: always() + with: + name: playwright-report + path: playwright-report/ + retention-days: 30 + env: + NEXT_PRIVATE_DATABASE_URL: postgresql://postgres:postgres@localhost:5432/documenso + NEXT_PRIVATE_DIRECT_DATABASE_URL: postgresql://postgres:postgres@localhost:5432/documenso + TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }} + TURBO_TEAM: ${{ vars.TURBO_TEAM }} diff --git a/.gitignore b/.gitignore index 246ce8bfe..3b0569b15 100644 --- a/.gitignore +++ b/.gitignore @@ -31,6 +31,7 @@ yarn-error.log* # turbo .turbo +.turbo-cookie # vercel .vercel diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 000000000..b03003160 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,55 @@ +tasks: + - init: | + npm i && + npm run dx:up && + cp .env.example .env && + set -a; source .env && + export NEXTAUTH_URL="$(gp url 3000)" && + export NEXT_PUBLIC_WEBAPP_URL="$(gp url 3000)" && + export NEXT_PUBLIC_MARKETING_URL="$(gp url 3001)" + command: npm run d + +ports: + - port: 3000 + visibility: public + onOpen: open-preview + - port: 3001 + visibility: public + onOpen: open-preview + - port: 9000 + visibility: public + onOpen: ignore + - port: 1100 + visibility: private + onOpen: ignore + - port: 2500 + visibility: private + onOpen: ignore + - port: 54320 + visibility: private + onOpen: ignore + + +github: + prebuilds: + master: true + pullRequests: true + pullRequestsFromForks: true + addCheck: true + addComment: true + addBadge: true + +vscode: + extensions: + - aaron-bond.better-comments + - bradlc.vscode-tailwindcss + - dbaeumer.vscode-eslint + - esbenp.prettier-vscode + - mikestead.dotenv + - unifiedjs.vscode-mdx + - GitHub.copilot-chat + - GitHub.copilot-labs + - GitHub.copilot + - GitHub.vscode-pull-request-github + - Prisma.prisma + - VisualStudioExptTeam.vscodeintellicode diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..5cf6aad4e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,126 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of + any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, + without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +support@documenso.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eca35cd8b..e2db661b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,20 +5,36 @@ If you plan to contribute to Documenso, please take a moment to feel awesome ✨ ## Before getting started - Before jumping into a PR be sure to search [existing PRs](https://github.com/documenso/documenso/pulls) or [issues](https://github.com/documenso/documenso/issues) for an open or closed item that relates to your submission. -- Select and issue from [here](https://github.com/documenso/documenso/issues) or create a new one -- Consider the results from the discussion in the issue +- Select an issue from [here](https://github.com/documenso/documenso/issues) or create a new one +- Consider the results from the discussion on the issue - Accept the [Contributor License Agreement](https://documen.so/cla) to ensure we can accept your contributions. +## Taking issues + +Before taking an issue, ensure that: + +- The issue has been assigned the public label +- The issue is clearly defined and understood +- No one has been assigned to the issue +- No one has expressed intention to work on it + +You can then: + +1. Comment on the issue with your intention to work on it +2. Begin work on the issue + +Always feel free to ask questions or seek clarification on the issue. + ## Developing -The development branch is main. All pull request should be made against this branch. If you need help getting started, [join us on Discord](https://documen.so/discord). +The development branch is main. All pull requests should be made against this branch. If you need help getting started, [join us on Discord](https://documen.so/discord). 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device. 2. Create a new branch: -- Create a new branch (include the issue id and somthing readable): +- Create a new branch (include the issue id and something readable): ```sh git checkout -b doc-999-my-feature-or-fix @@ -29,7 +45,7 @@ The development branch is main. All pull request should be made aga ## Building > **Note** -> Please be sure that you can make a full production build before pushing code or creating PRs. +> Please ensure you can make a full production build before pushing code or creating PRs. You can build the project with: diff --git a/README.md b/README.md index e0fc69d2f..8a8bc88eb 100644 --- a/README.md +++ b/README.md @@ -27,16 +27,9 @@ open in devcontainer + Contributor Covenant

-> 🦺 Documenso 1.0 is deployed to our Staging Environment. -> -> The code can be found on the [feat/refresh](https://github.com/documenso/documenso/tree/feat/refresh) branch. -> -> The new version will be released after the current testing phase. - -# Join us in testing Documenso 1.0 during [MALFUNCTION MANIA](https://documenso.com/blog/malfunction-mania) -
@@ -69,14 +62,14 @@ Join us in creating the next generation of open trust infrastructure. ## Community and Next Steps 🎯 -We're currently working on a redesign of the application, including a revamp of the codebase so Documenso can be more intuitive to use and robust to develop upon. +We're currently working on a redesign of the application, including a revamp of the codebase, so Documenso can be more intuitive to use and robust to develop upon. -- Check out the first source code release in this repository and test it -- Tell us what you think in the [Discussions](https://github.com/documenso/documenso/discussions) -- Join the [Discord server](https://documen.so/discord) for any questions and getting to know to other community members -- ⭐ the repository to help us raise awareness -- Spread the word on Twitter that Documenso is working towards a more open signing tool -- Fix or create [issues](https://github.com/documenso/documenso/issues), that are needed for the first production release +- Check out the first source code release in this repository and test it. +- Tell us what you think in the [Discussions](https://github.com/documenso/documenso/discussions). +- Join the [Discord server](https://documen.so/discord) for any questions and getting to know to other community members. +- ⭐ the repository to help us raise awareness. +- Spread the word on Twitter that Documenso is working towards a more open signing tool. +- Fix or create [issues](https://github.com/documenso/documenso/issues), that are needed for the first production release. ## Contributing @@ -110,7 +103,7 @@ Contact us if you are interested in our Enterprise plan for large organizations ### Requirements -To run Documenso locally you will need +To run Documenso locally, you will need - Node.js - Postgres SQL Database @@ -128,8 +121,7 @@ Want to get up and running quickly? Follow these steps: git clone https://github.com/documenso/documenso ``` -2. Set up your `.env` file using the recommendations in the `.env.example` file. Alternatively just run `cp .env.example .env` to get started with our handpicked defaults. - +2. Set up your `.env` file using the recommendations in the `.env.example` file. Alternatively, just run `cp .env.example .env` to get started with our handpicked defaults. 3. Run `npm run dx` in the root directory @@ -137,7 +129,6 @@ git clone https://github.com/documenso/documenso 4. Run `npm run dev` in the root directory - 5. Want it even faster? Just use ```sh @@ -157,7 +148,7 @@ npm run d ### Manual Setup -Follow these steps to setup documenso on you local machine: +Follow these steps to setup Documenso on your local machine: 1. [Clone the repository](https://help.github.com/articles/cloning-a-repository/) it to your local device. @@ -165,31 +156,32 @@ Follow these steps to setup documenso on you local machine: git clone https://github.com/documenso/documenso ``` -2. Run `npm i` in root directory +2. Run `npm i` in the root directory 3. Create your `.env` from the `.env.example`. You can use `cp .env.example .env` to get started with our handpicked defaults. -4. Set the following environement variables. - - NEXTAUTH_URL - - NEXTAUTH_SECRET - - NEXT_PUBLIC_WEBAPP_URL - - NEXT_PUBLIC_MARKETING_URL - - NEXT_PRIVATE_DATABASE_URL - - NEXT_PRIVATE_DIRECT_DATABASE_URL - - NEXT_PRIVATE_SMTP_FROM_NAME - - NEXT_PRIVATE_SMTP_FROM_ADDRESS +4. Set the following environment variables: -5. Create the database schema by running `npm run prisma:migrate-dev -w @documenso/prisma` + - NEXTAUTH_URL + - NEXTAUTH_SECRET + - NEXT_PUBLIC_WEBAPP_URL + - NEXT_PUBLIC_MARKETING_URL + - NEXT_PRIVATE_DATABASE_URL + - NEXT_PRIVATE_DIRECT_DATABASE_URL + - NEXT_PRIVATE_SMTP_FROM_NAME + - NEXT_PRIVATE_SMTP_FROM_ADDRESS -6. Run `npm run dev` root directory to start +5. Create the database schema by running `npm run prisma:migrate-dev` + +6. Run `npm run dev` in the root directory to start 7. Register a new user at http://localhost:3000/signup --- -- Optional: Seed the database using `npm run prisma:seed -w @documenso/prisma` to create a test user and document -- Optional: Create your own signing certificate - - To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL) see **[Create your own signing certificate](./SIGNING.md)**. +- Optional: Seed the database using `npm run prisma:seed -w @documenso/prisma` to create a test user and document. +- Optional: Create your own signing certificate. + - To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL), see **[Create your own signing certificate](./SIGNING.md)**. ### Run in Gitpod @@ -203,13 +195,80 @@ We support DevContainers for VSCode. [Click here to get started.](https://vscode ## Docker -🚧 Docker containers and images are current in progress. We are actively working on bringing a simple docker build and publish pipeline for Documenso. +🚧 Docker containers and images are current in progress. We are actively working on bringing a simple Docker build and publish pipeline for Documenso. ## Self Hosting We support a variety of deployment methods, and are actively working on adding more. Stay tuned for updates! -> Please note the below deployment methods are for v0.9, we will update these to v1.0 once it has been released. +> Please note that the below deployment methods are for v0.9, we will update these to v1.0 once it has been released. + +### Fetch, configure, and build + +First, clone the code from Github: + +``` +git clone https://github.com/documenso/documenso.git +``` + +Then, inside the `documenso` folder, copy the example env file: + +``` +cp .env.example .env +``` + +The following environement variables must be set: + +* `NEXTAUTH_URL` +* `NEXTAUTH_SECRET` +* `NEXT_PUBLIC_WEBAPP_URL` +* `NEXT_PUBLIC_MARKETING_URL` +* `NEXT_PRIVATE_DATABASE_URL` +* `NEXT_PRIVATE_DIRECT_DATABASE_URL` +* `NEXT_PRIVATE_SMTP_FROM_NAME` +* `NEXT_PRIVATE_SMTP_FROM_ADDRESS` + +> If you are using a reverse proxy in front of Documenso, don't forget to provide the public URL for both `NEXTAUTH_URL` and `NEXT_PUBLIC_WEBAPP_URL` variables! + +Now you can install the dependencies and build it: + +``` +npm i +npm run:build:web +npm run prisma:migrate-deploy +``` + +Finally, you can start it with: + +``` +npm run start +``` + +This will start the server on `localhost:3000`. For now, any reverse proxy can then do the frontend and SSL termination. + +> If you want to run with another port than 3000, you can start the application with `next -p ` from the `apps/web` folder. + +### Run as a service + +You can use a systemd service file to run the app. Here is a simple example of the service running on port 3500 (using 3000 by default): + +```bash +[Unit] +Description=documenso +After=network.target + +[Service] +Environment=PATH=/path/to/your/node/binaries +Type=simple +User=www-data +WorkingDirectory=/var/www/documenso/apps/web +ExecStart=/usr/bin/next start -p 3500 +TimeoutSec=15 +Restart=always + +[Install] +WantedBy=multi-user.target +``` ### Railway @@ -221,15 +280,15 @@ We support a variety of deployment methods, and are actively working on adding m ## Troubleshooting -### I'm not receiving any emails when using the developer quickstart +### I'm not receiving any emails when using the developer quickstart. -When using the developer quickstart an [Inbucket](https://inbucket.org/) server will be spun up in a docker container that will store all outgoing email locally for you to view. +When using the developer quickstart, an [Inbucket](https://inbucket.org/) server will be spun up in a docker container that will store all outgoing emails locally for you to view. -The Web UI can be found at http://localhost:9000 while the SMTP port will be on localhost:2500. +The Web UI can be found at http://localhost:9000, while the SMTP port will be on localhost:2500. ### Support IPv6 -In case you are deploying to a cluster that uses only IPv6. You can use a custom command to pass a parameter to the Next.js start command +If you are deploying to a cluster that uses only IPv6, You can use a custom command to pass a parameter to the Next.js start command For local docker run @@ -254,6 +313,22 @@ containers: - '::' ``` +### I can't see environment variables in my package scripts. + +Wrap your package script with the `with:env` script like such: + +``` +npm run with:env -- npm run myscript +``` + +The same can be done when using `npx` for one of the bin scripts: + +``` +npm run with:env -- npx myscript +``` + +This will load environment variables from your `.env` and `.env.local` files. + ## Repo Activity ![Repository Activity](https://repobeats.axiom.co/api/embed/622a2e9aa709696f7226304b5b7178a5741b3868.svg) diff --git a/apps/marketing/content/blog/building-documenso-pt1.mdx b/apps/marketing/content/blog/building-documenso-pt1.mdx index b8507be03..ad81a069b 100644 --- a/apps/marketing/content/blog/building-documenso-pt1.mdx +++ b/apps/marketing/content/blog/building-documenso-pt1.mdx @@ -1,6 +1,6 @@ --- title: 'Building Documenso — Part 1: Certificates' -description: This is the first part of the new Building Documenso series, where I describe the challenges and design choices that we make while building the world’s most open signing platform. +description: In today's fast-paced world, productivity and efficiency are crucial for success, both in personal and professional endeavors. We all strive to make the most of our time and energy to achieve our goals effectively. However, it's not always easy to stay on track and maintain peak performance. In this blog post, we'll explore 10 valuable tips to help you boost productivity and efficiency in your daily life. authorName: 'Timur Ercan' authorImage: '/blog/blog-author-timur.jpeg' authorRole: 'Co-Founder' diff --git a/apps/marketing/content/blog/design-system.mdx b/apps/marketing/content/blog/design-system.mdx new file mode 100644 index 000000000..24fe774b2 --- /dev/null +++ b/apps/marketing/content/blog/design-system.mdx @@ -0,0 +1,49 @@ +--- +title: Open Sourcing Documenso's Design +description: It's day 1 of our first launch week. We are kicking it off by open sourcing Documenso's design system! Let's go.. +authorName: 'Timur Ercan' +authorImage: '/blog/blog-author-timur.jpeg' +authorRole: 'Co-Founder' +date: 2023-09-25 +tags: + - Design + - Open Source + - Community +--- + +
+ + +
+ Documenso's Design System ✨ +
+
+ +> TLDR; Our design system is OSS under MIT at [design.documenso.com](https://design.documenso.com) + +Today, we are open sourcing our design system, lovingly crafted by [Thilo](https://twitter.com/thilokonzok). The system is public on Figma and will be available at [design.documenso.com](https://design.documenso.com) from here on out. +We are publishing it under the MIT License so everyone can share, remix, and use it as it helps them most. + +We chose to start our first launch week with a design topic to emphasize the role design will play in Documenso's company and community culture. As it is historically difficult to bring together open-source software with great design, this is our first step towards encouraging a more design-driven COSS (Commercial Open Source) movement. + +## Designers Welcome + +We added a designer role in our Discord to create a space for designers to explore and discuss design-related topics of Documenso and signing in general. In the future, we want to foster more coding contributions and start a design culture around the product. As it is much more difficult to incorporate design contributions, we have yet to find a clear plan of what that will look like. I would like to see contributions around stuff we are NOT working on. Designs in that area can inspire and start discussions without the complexities of implementing them immediately — a free-thinking space around everything Documenso. Having a free mandate to design without restriction can create many exciting ideas. Some Ideas worth exploring: + +## Areas for design contributions + +- Explorations of exciting aspects of signing and document handling: +- What does signing look like when we no longer have skeuomorphic signatures? +- What is signing if we move beyond paper-inspired documents? +- What would the government process look like using Documenso? +- Solutions Concepts for features further down the roadmap, e.g., Widgets in websites + +These are fascinating ideas for explorative design. They won't be built 1:1 but shape how we think about signing and where it can go, which is even more critical. If you are interested in product design, you are invited to join our [Discord](https://documen.so/discord) and discuss the future of signing design or the future of Documenso's design system. Also let me know what you think on [X (formerly Twitter)](https://x.com/eltimuro). + +Best from Hamburg\ +Timur diff --git a/apps/marketing/content/blog/early-adopters.mdx b/apps/marketing/content/blog/early-adopters.mdx index d4b5cb0ac..2ff7ae1f6 100644 --- a/apps/marketing/content/blog/early-adopters.mdx +++ b/apps/marketing/content/blog/early-adopters.mdx @@ -24,8 +24,6 @@ tags: -> TLDR; we have 100 early adopter accounts available at a great price. [Secure yours now](https://documenso.com/pricing). - ## Community-Driven Development As we ramp up hiring and development speed for Documenso, I want to discuss how we plan to build its core version. @@ -50,7 +48,7 @@ Documenso currently runs the community reviewed 0.9.1 version. Getting from here ## Extending our open metrics -As part of our ongoing effort to be open and transparent in our doing, we are adding "Early Adopters" to our [/open page](https://documenso.com/open) page. After we exceed the early adopter slots, this metric will transition to "Customers". When no more early adopter seats can be claimed, the early adopter plan will transition to a standard paid plan. It will still be priced at $30/mo., but will no longer include upcoming features or unlimited seats. You can [claim your early adopter account here](https://documenso.com/pricing). +As part of our ongoing effort to be open and transparent in our doing, we are adding "Early Adopters" to our [/open page](https://documenso.com/open) page. After we exceed the early adopter slots, this metric will transition to "Customers". When no more early adopter seats can be claimed, the early adopter plan will transition to a standard paid plan. It will still be priced at $30/mo., but will no longer include upcoming features or unlimited seats. If you have any questions or comments, please reach out on [Twitter / X](https://twitter.com/eltimuro) (DM open) or [Discord](https://documen.so/discord). diff --git a/apps/marketing/content/blog/live-roadmap-singleplayer.mdx b/apps/marketing/content/blog/live-roadmap-singleplayer.mdx new file mode 100644 index 000000000..d8b1f2c24 --- /dev/null +++ b/apps/marketing/content/blog/live-roadmap-singleplayer.mdx @@ -0,0 +1,75 @@ +--- +title: The 🔴 LIVE Roadmap +description: It's the Launch Week Day finale, Day 5! We are going out with a bang and introducing the 🔴 LIVE roadmap, featuring our next Product Hunt Launch - Free Singleplayer Documenso - Sign without creating an account! +authorName: 'Timur Ercan' +authorImage: '/blog/blog-author-timur.jpeg' +authorRole: 'Co-Founder' +date: 2023-09-29 +tags: + - Free Plan + - Launch + - Roadmap +--- + +
+ + +
+ "Being early is, uh, good." -Unknown +
+
+ +> TLDR; We are launching a [🔴 LIVE roadmap](https://documen.so/launches), that gets updated regularly.\ +> First upcoming launch: A free single signer experience. + +## The Road Ahead + +It's been quite a week, launching our [design system](https://documenso.com/blog/design-system), [kicking of a Malfunction Mania](https://documenso.com/blog/malfunction-mania), a [shiny new contributor perk](https://documenso.com/blog/shop) and our [early adopter deal](https://documenso.com/blog/early-adopters). After discussing Version 1.0 a lot, we want to close the week by looking ahead. As an open company, we want transparency about what we are working on and what to expect next. Especially for our Early Adopters, we want to paint a clear picture of what to expect in the near term. + +Communicating software development progress and goals is historically tricky because of it's complex nature. Exact release dates are notoriously unreliable; if they are not, they force a particular style of development, forcing the team to make tradeoffs on scope and quality. + +To give an appropriate insight into our work, we are launching our new [🔴 LIVE roadmap](https://documen.so/launches) today: + +- A List of quarterly development and feature goals +- That gets updated regularly (bi-weekly) +- Has up-to-date insights from the team on where we stand + +**While there are some great features planned, one stands out: Single Player Mode!** + +## Announcing Documenso Singleplayer Mode + + +
+ + +
+ 🚨 We are going back to Product Hunt! Are you ready, player one? +
+
+
+ +Single Player Mode will be a free, loginless signing experience for single signers. If you hate creating an account to sign a single, once-in-a-while-document yourself as much as we do, we've got you. Our new free tier will accompany Singleplayer. While you don't HAVE to create an account to sign sth. quickly, you can. A free tier Documenso Account will give you the following: + +- A place to store all your sent and received Documenso-signed documents +- Free forever +- Unlimited recipients +- 5 free signatures per month (for now, excluding third party types like QES) +- The use of templates, as soon as we [release](https://documen.so/launches) them + +Singleplayer will launch in the first half of October, shortly after the release of 1.0, **[ON PRODUCT HUNT!](https://www.producthunt.com/products/documenso)** That's right, we are going back to Product Hunt to kick of this new phase of Documenso and you are invited to join us once again :) + +**[Subscribe on PH](https://www.producthunt.com/products/documenso)** to be notified when we launch. + +If you have any questions or comments, please reach out on [Twitter / X](https://twitter.com/eltimuro) (DM open) or [Discord](https://documen.so/discord). + +Best from Hamburg\ +Timur diff --git a/apps/marketing/content/blog/malfunction-mania.mdx b/apps/marketing/content/blog/malfunction-mania.mdx index c1f5732f0..ebc7bc0d0 100644 --- a/apps/marketing/content/blog/malfunction-mania.mdx +++ b/apps/marketing/content/blog/malfunction-mania.mdx @@ -16,7 +16,7 @@ tags: src="/blog/mm.png" width="1260" height="630" - alt="Malfunctioning Documenso Logo inbroken colors" + alt="Malfunctioning Documenso Logo in broken colors" />
@@ -49,9 +49,9 @@ As Documenso 1.0 just hit the staging environment, we're calling a MALFUNCTION M - Fix bugs by creating a Pull Request (PR); - Look over and add missing documentation/ Quickstarts and other useful resources. -We don't have a specific end date for Malfunction Mania. We plan to move the staging version into the production environment by the end of the month once we're happy with the results. Bug reports and fixes are, of course, always welcome going forward. - Best from Hamburg Timur +We don't have a specific end date for Malfunction Mania. We plan to move the staging version into the production environment by the end of the month once we're happy with the results. Bug reports and fixes are, of course, always welcome going forward. + **[Follow Documenso on Twitter / X](https://documen.so/tw) and [join the Discord server](https://documen.so/discord) to get the latest about Malfunction Mania.** diff --git a/apps/marketing/content/blog/next.mdx b/apps/marketing/content/blog/next.mdx index 2f83fe3ef..6bc14e053 100644 --- a/apps/marketing/content/blog/next.mdx +++ b/apps/marketing/content/blog/next.mdx @@ -12,7 +12,7 @@ tags: Since we launched [Documenso 0.9 on Product Hunt](https://producthunt.com/products/documenso#documenso) last May, the team's been hard at work behind the scenes to ramp up development and design to deliver an excellent next version. -Last week, Lucas shared the reasoning on [why we're doing a rewrite](https://documenso.com/blog/why-were-doing-a-rewrite). +Last week, Lucas shared the reasoning how [why we're doing a rewrite](https://documenso.com/blog/why-were-doing-a-rewrite). Today, I'm pleased to share with you a preview of the next Documenso. diff --git a/apps/marketing/content/design-system.mdx b/apps/marketing/content/design-system.mdx new file mode 100644 index 000000000..b6982e728 --- /dev/null +++ b/apps/marketing/content/design-system.mdx @@ -0,0 +1,42 @@ +--- +title: Design System +--- + +# We're building a beautiful, open-source alternative to DocuSign + +> Read more about our design culture here: +> +> [https://documenso.com/blog/design-system](https://documenso.com/blog/design-system) + +At Documenso, we aim to be a design-driven company. + +We believe that design isn't just about how things look, but also how they work. We want to make sure that the product is easy to use and intuitive. We also want to ensure that the website, desktop and mobile apps are consistent and look and feel like they belong together. + +To achieve this, we've created Documenso's design system containing tokens, primitives, and components, screens, and brand assets. + +We're open-sourcing this design system so you can see how we build the product and think about design as a whole. + +## Check out the design system + +