Description

Updated Issue template because when choosing new issues, they were hard to differentiate between the different issue templates.

Related Issue

Fixes #31

Motivation and Context

Issues were hard to differentiate.

How Has This Been Tested?

n/a

Screenshots (if appropriate):

n/a

Project can be viewed by anyone but isn't technically open source. Want to actually open source it.

Details:

• Added License, Code of Conduct, Contribution files and updated the Readme
• Added pull request and issue templates. I especially like the idea of having an issue specifically for dev experience as that's something that's quite important to me. idea came from Defaang

Just working on a few Accessibility issues that @jfc3 found while at a meet up.

Fixes #22 Fixes #23 Fixes #24 Fixes #25

Details:

Not too much crazy stuff here

• There was an error in types where sent_at was accidentally called send_at. That was fixed
• Added YouTube link since I had to update the footer anyhow
• Learned that Chakra UI has a fair amount of props that represent CSS. When editing Chakra UI components, start with leveraging props for CSS instead of immediately using Tailwind.
• Centered links in nav because looking at other sites, their links are centered and they look better.

Details:

• The type for pagelayout didn't allow the inputting of props so had to fix that.
• Newsletter currently is the only page component that takes props (serversideprops) so it's now set up to infer types from getServerSideProps.
• Also decided to move pages folder and styles folder into src to clean up root folder
• Fixed a few issues with some stories

Original idea for deploying Storybook wasn't going to work but found a way to deploy Storybook with Vercel which now involves merging dev into the Storybook branch to trigger a deployment.

Quickly fixing an issue I noticed where links weren't working.

Next wasn't properly creating an 'a' tag for the links. Made some changes but will have to revisit in the future for a proper fix.

Cleaning up the project like fixing a few things with the nav and cleaning up the README before release.

Details:

• Was able to replace the a link with the next link component
• Wrote the README for the project
• Made active link work. It's currently an underline for now
• Made a new molecule called Newsletter Entry where each newsletter card will be described
• Made the nav bar stick permanently to the top of the screen

Creating the newsletter page where people can sign up for the newsletter and view the first ten newsletter issues.

Details:

One of the more heavy API pages of the app currently

• Created a get request to get a list of all the newsletter issues so far and then filter the first ten. This is done through getServerSideProps so it'll help a bit with SEO.
• Created a post request to send an email to revue to add them as a subscriber. For whatever reason, I was getting a CORS error and a solution was adding the request to the Node instance so I did that. So completely forgot that I'd expose the Revue key if I did things client side so this was a good implementation. Or at least I think it is.
• Made several atoms and molecules to support the newsletter page.

Replace the Lorem Ipsum about page with actual content.

Details:

• Created Card component which can be made into section, article or just a div
• Added Card component to home page
• Created basic About page
• Learned that to make Chakra UI Text components into specific html elements, you need to use 'as' prop.

Added posthog to website for analytics.

Details:

Nothing much going on here

• Moved .env to .env.local since we don't have a local .env variable
• Installed posthog and added it to app through the file analytics.ts
• Implemented posthog in app (Next.js has a particular implementation that is documented here: https://posthog.com/docs/integrate/third-party/next-js)

Implementing API layer to make spinning up accessing endpoints easier.

Details:

• Set up a main api function with axios that endpoints will inherit from
• Set up hooks to use endpoints to use meta data for components
• Wrote example usage of api layer
• Made some changes to header component to solve a React warning

Feature Request

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I have an issue when [...]

Currently, the TechIsHiring newsletter is on Revue. Revue today has announced that it will be discontinuing service which forces the newsletter to move elsewhere. The integration with Revue will need to be updated once a new newsletter service is identified.

Describe the solution you'd like A clear and concise description of what you want to happen. Add any considered drawbacks.

As of right now, Substack seems to be a very suitable replacement for Revue. If the newsletter is migrated to Substack, then integration would need to be moved to leverage that.

May also explore other newsletter services as well but more likely Substack will be the service of choice.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Alternatives are still being determined.

Teachability, Documentation, Adoption, Migration Strategy If you can, explain how users will be able to use this and possibly write out a version in the docs. Maybe a screenshot or design?

n/a

Feature Request

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I have an issue when [...]

Once #29 is completed, we will need to add a test for the project.

Describe the solution you'd like A clear and concise description of what you want to happen. Add any considered drawbacks.

Things to test:

lib folder:

• utils: capitalize, verify-email
• api: Not sure how to test this yet

pages folder:

I honestly don't know how to test Next.js components so I'd need to look that up.

components folder:

How should I test React Components

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Specifically for the components folder, I'm considering adding unit tests for each component in the folder or adding Cypress and testing flows through the application itself. I'm more knowledgeable on unit tests but I think Cypress will be a great learning experience and potentially better for testing components that mainly focuses on display.

Teachability, Documentation, Adoption, Migration Strategy If you can, explain how users will be able to use this and possibly write out a version the docs. Maybe a screenshot or design?

will do this later

Feature Request

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I have an issue when [...]

There is currently no automated tests for the project.

Describe the solution you'd like A clear and concise description of what you want to happen. Add any considered drawbacks.

We should add Jest, React Testing Library and Cypress to the project.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Haven't considered any alternatives at this time.

Teachability, Documentation, Adoption, Migration Strategy If you can, explain how users will be able to use this and possibly write out a version the docs. Maybe a screenshot or design?

n/a

Currently the Design System for several components that should be dynamic is mostly static.

Need to update the Design System to that some components are more dynamic.

Whenever I try to create a PR into main, I always have to resolve merge conflicts which is just accepting current.

Need to find out why that is so I can have more frictionless releases.