Skip to content

3cn-ecn/signature-generator

Repository files navigation

Signature Generator

An email signature generator for clubs and organizations. Feel free to fork it to create your own signature template!

User features

  • Create your own email signature with your organization's logo and design
  • Use Markdown to format your signature
  • Export your signature into multiple formats (HTML, source code, plain text)

>>> Test it now! <<<

How to adapt it for your own organization

  1. Fork this repository
  2. Authorize workflows in the "Actions" tab
  3. Setup GitHub Pages: Settings > Pages > Select under Source: "GitHub Actions"
  4. Update the baseUrl property of the vite.config.ts with your repo name
  5. Update the signature:
    • Update the signature logo by replacing the public/logo_signature.png image
    • Change the email signature's design by modifying files in src/emailSignatureTemplate
  6. Optional: change the builder design by modifying files in src/builderLayout

Dev stuff

Useful commands

  • npm run dev: Start the development server
  • npm run lint: Find potential errors and fixes for the code

Libraries used

  • This generator is built with react and vite, with mui for the builder design.

  • For the email signature's template, we use react-email components, which allow maximum compatibility with all email clients (gmail, outlook, etc...).

About

A signature generator for clubs and organizations. Feel free to fork it to create your own signature template!

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •