digitalnsw / nsw-email-signature-generator

Welcome to the NSW Government Email Signature Generator repository! This tool helps create consistent and professional email signatures for NSW Government employees.

NSW Email Signature Generator

Developed with the software and tools below.

---

Quick Links

• Overview
• Features
• Repository Structure
• Modules
• Getting Started
  • Installation
  • Running nsw-email-signature-generator

---

Overview

Welcome to the NSW Government Email Signature Generator repository! This tool helps create consistent and professional email signatures for NSW Government employees.

---

Features

• Easy Customisation: Customize your signature with details like name, job title, department, contact information, and social media links.
• Brand Compliance: Ensures compliance with NSW Government branding guidelines.
• HTML and Text Versions: Generate both HTML code and plain text versions of your signature for easy integration with various email clients.
• Responsive Design: Signatures are optimised for different screen sizes and email clients.

---

Repository Structure

└── nsw-email-signature-generator/
    ├── .github
    │   └── workflows
    │       └── nextjs.yml
    ├── README.md
    ├── next.config.mjs
    ├── package-lock.json
    ├── package.json
    ├── postcss.config.mjs
    ├── public
    │   ├── banner.png
    │   ├── email.png
    │   ├── facebook.png
    │   ├── favicon.ico
    │   ├── favicon.png
    │   ├── favicon.svg
    │   ├── instagram.png
    │   ├── linkedin.png
    │   ├── nsw-logo.png
    │   ├── nsw-logo.svg
    │   ├── twitter.png
    │   └── youtube.png
    ├── src
    │   ├── app
    │   │   ├── globals.css
    │   │   ├── layout.tsx
    │   │   └── page.tsx
    │   ├── components
    │   │   ├── browser.tsx
    │   │   ├── copyButtons.jsx
    │   │   ├── form.jsx
    │   │   ├── logo.tsx
    │   │   ├── options.tsx
    │   │   ├── sidebar.tsx
    │   │   ├── signature
    │   │   │   ├── address.jsx
    │   │   │   ├── banner.jsx
    │   │   │   ├── contacts.jsx
    │   │   │   ├── days.jsx
    │   │   │   ├── department.jsx
    │   │   │   ├── descriptor.jsx
    │   │   │   ├── hr.jsx
    │   │   │   ├── logo.jsx
    │   │   │   ├── logoimage.jsx
    │   │   │   ├── message.jsx
    │   │   │   ├── name.jsx
    │   │   │   ├── social.jsx
    │   │   │   ├── spacer.jsx
    │   │   │   ├── team.jsx
    │   │   │   ├── title.jsx
    │   │   │   └── url.jsx
    │   │   ├── signature.jsx
    │   │   ├── tabs.tsx
    │   │   └── toggle.jsx
    │   └── utils
    │       └── utils.js
    ├── tailwind.config.ts
    └── tsconfig.json

---

Modules

.

File	Summary
postcss.config.mjs	HTTP error 401 for prompt postcss.config.mjs
tailwind.config.ts	HTTP error 401 for prompt tailwind.config.ts
tsconfig.json	HTTP error 401 for prompt tsconfig.json
package.json	HTTP error 401 for prompt package.json
next.config.mjs	HTTP error 401 for prompt next.config.mjs
package-lock.json	HTTP error 401 for prompt package-lock.json

.github.workflows

File	Summary
nextjs.yml	HTTP error 401 for prompt .github/workflows/nextjs.yml

src.utils

File	Summary
utils.js	HTTP error 401 for prompt src/utils/utils.js

src.components

File	Summary
copyButtons.jsx	HTTP error 401 for prompt src/components/copyButtons.jsx
tabs.tsx	HTTP error 401 for prompt src/components/tabs.tsx
signature.jsx	HTTP error 401 for prompt src/components/signature.jsx
browser.tsx	HTTP error 401 for prompt src/components/browser.tsx
form.jsx	HTTP error 401 for prompt src/components/form.jsx
sidebar.tsx	HTTP error 401 for prompt src/components/sidebar.tsx
toggle.jsx	HTTP error 401 for prompt src/components/toggle.jsx
options.tsx	HTTP error 401 for prompt src/components/options.tsx
logo.tsx	HTTP error 401 for prompt src/components/logo.tsx

src.components.signature

File	Summary
hr.jsx	HTTP error 401 for prompt src/components/signature/hr.jsx
descriptor.jsx	HTTP error 401 for prompt src/components/signature/descriptor.jsx
name.jsx	HTTP error 401 for prompt src/components/signature/name.jsx
team.jsx	HTTP error 401 for prompt src/components/signature/team.jsx
url.jsx	HTTP error 401 for prompt src/components/signature/url.jsx
message.jsx	HTTP error 401 for prompt src/components/signature/message.jsx
contacts.jsx	HTTP error 401 for prompt src/components/signature/contacts.jsx
title.jsx	HTTP error 401 for prompt src/components/signature/title.jsx
social.jsx	HTTP error 401 for prompt src/components/signature/social.jsx
logoimage.jsx	HTTP error 401 for prompt src/components/signature/logoimage.jsx
logo.jsx	HTTP error 401 for prompt src/components/signature/logo.jsx
banner.jsx	HTTP error 401 for prompt src/components/signature/banner.jsx
department.jsx	HTTP error 401 for prompt src/components/signature/department.jsx
address.jsx	HTTP error 401 for prompt src/components/signature/address.jsx
spacer.jsx	HTTP error 401 for prompt src/components/signature/spacer.jsx
days.jsx	HTTP error 401 for prompt src/components/signature/days.jsx

src.app

File	Summary
globals.css	HTTP error 401 for prompt src/app/globals.css
page.tsx	HTTP error 401 for prompt src/app/page.tsx
layout.tsx	HTTP error 401 for prompt src/app/layout.tsx

---

Getting Started

Installation

1. Clone the nsw-email-signature-generator repository:

git clone https://github.com/digitalnsw/nsw-email-signature-generator

2. Change to the project directory:

cd nsw-email-signature-generator

3. Install the dependencies:

npm install

Running nsw-email-signature-generator

Use the following command to run nsw-email-signature-generator:

npm run dev

---