2023-01-07 18:19:08 +01:00
|
|
|
{
|
2023-06-09 18:21:18 +10:00
|
|
|
"private": true,
|
2024-12-05 13:57:05 +11:00
|
|
|
"version": "1.8.1",
|
2023-01-09 09:43:58 +01:00
|
|
|
"scripts": {
|
2023-06-09 18:21:18 +10:00
|
|
|
"build": "turbo run build",
|
2023-10-04 19:58:07 +00:00
|
|
|
"build:web": "turbo run build --filter=@documenso/web",
|
2024-07-23 08:03:53 +05:30
|
|
|
"dev": "turbo run dev --filter=@documenso/web",
|
|
|
|
|
"dev:web": "turbo run dev --filter=@documenso/web",
|
|
|
|
|
"dev:marketing": "turbo run dev --filter=@documenso/marketing",
|
|
|
|
|
"dev:docs": "turbo run dev --filter=@documenso/documentation",
|
feat: documentation site (#1101)
## Description
<!--- Describe the changes introduced by this pull request. -->
<!--- Explain what problem it solves or what feature/fix it adds. -->
## Related Issue
<!--- If this pull request is related to a specific issue, reference it
here using #issue_number. -->
<!--- For example, "Fixes #123" or "Addresses #456". -->
## Changes Made
<!--- Provide a summary of the changes made in this pull request. -->
<!--- Include any relevant technical details or architecture changes.
-->
- Change 1
- Change 2
- ...
## Testing Performed
<!--- Describe the testing that you have performed to validate these
changes. -->
<!--- Include information about test cases, testing environments, and
results. -->
- Tested feature X in scenario Y.
- Ran unit tests for component Z.
- Tested on browsers A, B, and C.
- ...
## Checklist
<!--- Please check the boxes that apply to this pull request. -->
<!--- You can add or remove items as needed. -->
- [ ] 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
<!--- Provide any additional context or notes for the reviewers. -->
<!--- This might include details about design decisions, potential
concerns, or anything else relevant. -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Enhanced project README for clarity and improved environment variables
section.
- Added comprehensive developer and user documentation, including guides
on local development, public API, self-hosting, and compliance
standards.
- Introduced specific guides for contributing, creating API keys, using
webhooks, and setting up security measures.
- Detailed documentation on various fields available for document
signing to improve user understanding.
- Added metadata structuring to improve navigation within the
documentation site.
- **Chores**
- Updated `.gitignore` to better handle project files.
- **New Features**
- Introduced detailed metadata and documentation for various Documenso
functionalities, including signing documents, user profiles, and
compliance levels.
- Added functionality for Direct Link Signing, enabling easy sharing for
document signing.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Timur Ercan <timur.ercan31@gmail.com>
Co-authored-by: Lucas Smith <me@lucasjamessmith.me>
Co-authored-by: David Nguyen <davidngu28@gmail.com>
2024-07-22 14:34:37 +03:00
|
|
|
"start": "turbo run start --filter=@documenso/web --filter=@documenso/marketing --filter=@documenso/documentation",
|
2023-06-09 18:21:18 +10:00
|
|
|
"lint": "turbo run lint",
|
2023-11-14 14:31:45 +05:30
|
|
|
"lint:fix": "turbo run lint:fix",
|
2023-08-16 06:27:45 -05:00
|
|
|
"format": "prettier --write \"**/*.{js,jsx,cjs,mjs,ts,tsx,cts,mts,mdx}\"",
|
2023-08-18 13:49:46 +05:30
|
|
|
"prepare": "husky install",
|
2023-09-21 21:34:24 +10:00
|
|
|
"commitlint": "commitlint --edit",
|
2023-09-30 00:43:45 +10:00
|
|
|
"clean": "turbo run clean && rimraf node_modules",
|
|
|
|
|
"d": "npm run dx && npm run dev",
|
2024-03-07 20:09:29 +00:00
|
|
|
"dx": "npm i && npm run dx:up && npm run prisma:migrate-dev && npm run prisma:seed",
|
2024-03-06 15:46:51 +11:00
|
|
|
"dx:up": "docker compose -f docker/development/compose.yml up -d",
|
|
|
|
|
"dx:down": "docker compose -f docker/development/compose.yml down",
|
2024-01-04 23:40:35 +05:30
|
|
|
"ci": "turbo run test:e2e",
|
2023-10-18 17:03:02 +05:30
|
|
|
"prisma:generate": "npm run with:env -- npm run prisma:generate -w @documenso/prisma",
|
|
|
|
|
"prisma:migrate-dev": "npm run with:env -- npm run prisma:migrate-dev -w @documenso/prisma",
|
|
|
|
|
"prisma:migrate-deploy": "npm run with:env -- npm run prisma:migrate-deploy -w @documenso/prisma",
|
2024-05-29 14:47:33 +10:00
|
|
|
"prisma:migrate-reset": "npm run with:env -- npm run prisma:migrate-reset -w @documenso/prisma",
|
2023-11-30 18:38:54 +01:00
|
|
|
"prisma:seed": "npm run with:env -- npm run prisma:seed -w @documenso/prisma",
|
2024-03-08 02:45:22 +00:00
|
|
|
"prisma:studio": "npm run with:env -- npm run prisma:studio -w @documenso/prisma",
|
2023-10-18 17:03:02 +05:30
|
|
|
"with:env": "dotenv -e .env -e .env.local --",
|
2023-12-09 06:00:15 +05:30
|
|
|
"reset:hard": "npm run clean && npm i && npm run prisma:generate",
|
2024-05-15 21:54:16 +10:00
|
|
|
"precommit": "npm install && git add package.json package-lock.json",
|
2024-06-21 14:22:22 +10:00
|
|
|
"trigger:dev": "npm run with:env -- npx trigger-cli dev --handler-path=\"/api/jobs\"",
|
2024-07-19 13:27:01 +10:00
|
|
|
"inngest:dev": "inngest dev -u http://localhost:3000/api/jobs",
|
2024-07-26 14:56:42 +10:00
|
|
|
"make:version": " npm version --workspace @documenso/web --workspace @documenso/marketing --include-workspace-root --no-git-tag-version -m \"v%s\"",
|
2024-12-06 07:04:15 +09:00
|
|
|
"translate:extract": "lingui extract --clean",
|
2024-07-26 14:56:42 +10:00
|
|
|
"translate:compile": "turbo run translate:compile --filter=@documenso/web --filter=@documenso/marketing --filter=@documenso/ui"
|
2023-01-09 09:43:58 +01:00
|
|
|
},
|
2024-06-21 13:07:30 +10:00
|
|
|
"packageManager": "npm@10.7.0",
|
2023-08-21 18:54:44 +05:30
|
|
|
"engines": {
|
2024-06-21 13:07:30 +10:00
|
|
|
"npm": ">=10.7.0",
|
2023-08-21 18:54:44 +05:30
|
|
|
"node": ">=18.0.0"
|
|
|
|
|
},
|
2023-06-09 18:21:18 +10:00
|
|
|
"devDependencies": {
|
2023-08-18 13:26:01 +05:30
|
|
|
"@commitlint/cli": "^17.7.1",
|
|
|
|
|
"@commitlint/config-conventional": "^17.7.0",
|
2024-09-03 09:48:54 +10:00
|
|
|
"@lingui/cli": "^4.11.3",
|
2024-05-15 21:54:16 +10:00
|
|
|
"@trigger.dev/cli": "^2.3.18",
|
2023-10-04 20:04:07 +05:30
|
|
|
"dotenv": "^16.3.1",
|
|
|
|
|
"dotenv-cli": "^7.3.0",
|
2023-08-30 12:35:43 +10:00
|
|
|
"eslint": "^8.40.0",
|
2023-06-09 18:21:18 +10:00
|
|
|
"eslint-config-custom": "*",
|
2024-03-09 00:32:08 +05:30
|
|
|
"husky": "^9.0.11",
|
|
|
|
|
"lint-staged": "^15.2.2",
|
2024-04-26 13:18:31 +10:00
|
|
|
"playwright": "1.43.0",
|
2024-11-26 11:47:28 +11:00
|
|
|
"prettier": "^3.3.3",
|
2023-09-21 21:34:24 +10:00
|
|
|
"rimraf": "^5.0.1",
|
2023-06-09 18:21:18 +10:00
|
|
|
"turbo": "^1.9.3"
|
|
|
|
|
},
|
2023-08-29 16:19:56 -05:00
|
|
|
"name": "@documenso/root",
|
2023-01-07 18:19:08 +01:00
|
|
|
"workspaces": [
|
|
|
|
|
"apps/*",
|
2023-08-01 17:34:17 +10:00
|
|
|
"packages/*"
|
2023-11-06 14:47:46 +11:00
|
|
|
],
|
2024-01-25 10:48:20 +02:00
|
|
|
"dependencies": {
|
2024-03-15 22:26:09 +11:00
|
|
|
"@documenso/pdf-sign": "^0.1.0",
|
2024-09-03 09:48:54 +10:00
|
|
|
"@lingui/core": "^4.11.3",
|
2024-06-14 13:53:48 +10:00
|
|
|
"inngest-cli": "^0.29.1",
|
2024-05-16 15:44:39 +10:00
|
|
|
"next-runtime-env": "^3.2.0",
|
2024-09-03 09:48:54 +10:00
|
|
|
"react": "^18"
|
2024-01-25 10:48:20 +02:00
|
|
|
},
|
2023-12-02 09:38:24 +11:00
|
|
|
"overrides": {
|
2024-09-03 09:48:54 +10:00
|
|
|
"next": "14.2.6"
|
2024-05-15 21:54:16 +10:00
|
|
|
},
|
|
|
|
|
"trigger.dev": {
|
|
|
|
|
"endpointId": "documenso-app"
|
2023-11-06 14:47:46 +11:00
|
|
|
}
|
2024-12-06 07:04:15 +09:00
|
|
|
}
|