The F2E WEEK2 - E Signature

Features

• guest
  • create new file
    • upload
    • signature
    • download
    • google drive (optional)
    • dropbox (optional)
• authenticated
  • create new file
    • upload
      • snapshot
      • [ ]upload
      • create new page (optional)
      • history (optional)
    • signature
    • invite
    • download
    • share (optional)
  • file manager
    • filter
      • date
      • title
      • signer
    • signed
    • draft
    • pending
  • setting
    • config
    • list of common signer
  • integration (optional)
    • colleague
    • cooperator

What's in the stac

• Fly app deployment with Docker

• Healthcheck endpoint for Fly backups region fallbacks

• GitHub Actions for deploy on merge to production and staging environments

• Styling with Tailwind

• End-to-end testing with Cypress

• Local third party request mocking with MSW

• Unit testing with Vitest and Testing Library

• Code formatting with Prettier

• Linting with ESLint

• Static Types with TypeScript

• A practical functional library with Ramda

• PDF related:

  • pdfjs: PDF reader
  • jspdf: array-buffer to PDF
  • pdf-merger-js: for merge multiple pdf into one

• Canvas Control with Konva

Development

• This step only applies if you've opted out of having the CLI install dependencies for you:

npx remix init

• Initial setup: If you just generated this project, this step has been done for you.

npm run setup

• Start dev server:

npm run dev

This starts your app in development mode, rebuilding assets on file changes.

Deployment

This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments.

Now that everything is set up you can commit and push your changes to your repo.

Every commit to your main branch will trigger a deployment to your production environment, and every commit to your dev branch will trigger a deployment to your staging environment.

GitHub Actions

We use GitHub Actions for continuous integration and deployment. Anything that gets into the main branch will be deployed to production after running tests/build/etc. Anything in the dev branch will be deployed to staging.

Testing

Cypress

We use Cypress for our End-to-End tests in this project. You'll find those in the cypress directory. As you make changes, add to an existing file or create a new file in the cypress/e2e directory to test your changes.

We use @testing-library/cypress for selecting elements on the page semantically.

To run these tests in development, run npm run test:e2e:dev which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above.

Vitest

For lower level tests of utilities and individual components, we use vitest. We have DOM-specific assertion helpers via @testing-library/jest-dom.

Type Checking

This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run npm run typecheck.

Linting

This project uses ESLint for linting. That is configured in .eslintrc.js.

Formatting

We use Prettier for auto-formatting in this project. It's recommended to install an editor plugin (like the VSCode Prettier plugin) to get auto-formatting on save. There's also a npm run format script you can run to format all files in the project.