bluewave-labs/bluewave-hrm

Implement email templates

gorkem-bwl opened this issue ยท 32 comments

Implement email templates for the following actions. This requires writing an HTML template with proper wording/sentences.

Signup/sign in related

  • When an HRM manager starts the employee activation process
    An email to the employee
  • When a new employee/HR manager signs up (welcome email)
    An email to the HRM manager
    An email to the employee
  • When employee forgets email
  • Activation email

HRM application related

  • When an employee changes job description
    An email to the employee
    An email to the HRM manager
    An email to the employee's manager (if exists)
  • When an employee leaves the company
    An email to the HRM manager
    An email to the employee's manager (if exists)
  • When an employee asks for a leave
    An email to the HRM manager
    An email to the employee's manager (if exists)
  • When a time off request is created
    An email to the HRM manager
    An email to the employee
    An email to the employee's manager (if exists)
  • When a leave is accepted/denied
    An email to the HRM manager
    An email to the employee
    An email to the employee's manager (if exists)

Is your project open source?

I am a new developer but I can attempt to implement these changes. I can start with one html file and submit PR for review?

Sure, go ahead. Make sure you check other email templates and also honor their licenses (eg use templates with a permissive license) before opening a PR. Note that those emails should be in a template format. They better look good, simple and easy to the eyes.

I've added one email template. It was created with the help of AI so no licensing restrictions. If code is up to par, I can implement the remaining templates.

Looks good. Go ahead and implement the remaining. Just a note that there might be additional modifications to the templates in the future depending on how the backend will generate them and send.

I've implemented a total of 18 email templates. Please review PR #26

I have created a design template for this. Can you implement this one in yours?

Email design template

You want that template as a separate html file?

Yes you can give html file as well

Ok, I will add to PR #26

It's done ๐Ÿ‘

Can you add this styling to your templates @louisv20 ?

Email design template

Logo:
Enthalpy-logo

I can add logo and button. I'm not sure how to appropriately implement bullet points and lists into the subject matter
Screenshot (399)

Bullet points and lists are just html elements. Those would be in the template file, and not necessarily in each email.

Bullet points and lists are just html elements. Those would be in the template file, and not necessarily in each email.

Will something like this work for each email?
Screenshot (402)

Yes, that would work for each email. Note that you don't have to use styling if there is no need. That template is given as an example.

Yes, that would work for each email. Note that you don't have to use styling if there is no need. That template is given as an example.

I've made the necessary changes. Please review to merge.

Thanks @louisv20 for resolving this issue!
I want to contribute to this issue with my methodology. Please @gorkem-bwl allow me to give my solutions.
I'm also familiar with HTML, and javascript. I am happy to answer any follow-up questions.

Thanks @louisv20 for resolving this issue! I want to contribute to this issue with my methodology. Please @gorkem-bwl allow me to give my solutions. I'm also familiar with HTML, and javascript. I am happy to answer any follow-up questions.

Sure, go ahead Rishab!

I have created something valuable to this issue, There is a working video file attached to it. I tried my best efficient methodology to the extent of my knowledge.

Template_Rex.mp4

I look forward to your feedback @gorkemcetin !

That looks good, @Gol0DRoger - let me create a Figma design file for this and move from there. It will have tabs on the left for each email, and will separate subject and body as two editors. We also need a list of tags to use here so the end user can know which tags to use (eg. [Company name] or [Last day of the work].

Great, Let's see. @gorkem-bwl I am not sure if I would be able to execute all of that, but will try.

Can you also remove all the styling from the templates, and use {{ }} for the placeholders? @Gol0DRoger

This way the styling is not in the templates and the editor only accepts text as well. Let's get rid of the HTML elements completely.

Example:

Dear {{Employee Name}}

We received a request to reset your password. Please click the link below to reset your password:

{{Reset Link}}

If you did not request a password reset, please ignore this email.

If you have any questions, feel free to contact us at {{Support email}}.

Best,
{{Company name}}

@gorkem-bwl see this one, I executed the changes. No styling/css.
Screenshot 2024-06-27 163914

Yes, better looks like this (each and every of them). Need newlines as well. Make sure it is readable.

ok fine.

I have executed all the changes in all templates and added PR #37 . Please review it and get it merged.

Template_Final3.mp4

@gorkem-bwl

@bolatein can you come up with a design for this? Each section can be a tab on the left, and contents can go to the right.

@Gol0DRoger we also need to separate the subject and contents of the email. After @bolatein is done with the design, you need to use our Figma design guidelines to come up with a UI design. After the review, we can merge.

Fine, I will wait for further updates from your side @gorkem-bwl @bolatein.Then I will make the required changes.

Thank you @Gol0DRoger @louisv20 for your contributions here. I created #57 for MJML templates now and it will be assigned to a developer by @zaidi201 .