1.0.0 Full Release (#13)

* Added types definition file to facilitate page layout types.

* Set up layouts in _app.tsx. Also updated next from latest to ^12.3.1 to avoid breaking changes on deployment.

* Created Atomic Design folder structure for stories.

* Experimenting with migrating default next page into components to make sure layout works.

* Continuing the default next page migration process.

* Got default layout component set up. Now trying to figure out why assigning it as a parameter in an object is not working.

* Got the layout working but Tailwind broke so I need to work on that.

* Fixed issue with Tailwind. Config file was pointing to the wrong place.

* Building the header and footer of the site (#2)

* Made some minor changes to structure of app.

* Setting up atoms needed for header and footer.

* Added TechIsHirng logo and corresponding story.

* Created Icon atom with corresponding stories.

* Forgot to add a story for default layout so quickly threw one together.

* Created header and added logo.

* Added socials to footer with links.

* Adding header and footer stories.

* Forgot to add GitHub icon.

* Some clean up and adding a way to easily clean install node_modules.

* Added single navlink and main nav components and corresponding stories.

* Added main nav to header without styling. Will style now.

* Did some quick clean up and added a general link atom and its corresponding story.

* Styled the desktop navigation and started work on mobile navigation.

* Added mobile menu. Added Chakra UI to implement mobile menu. Will leverage Chakra UI components in the future.

* Added actual links to pages. Pages currently do not exist.

* Added typography and their corresponding stories.

* Updating link component for logo.

* Putting key in maps for navList.

* Adding the twitter list for TechIsHiring to body of app (#3)

* Moved main html tag to layout.

* Just quickly made other pages for the other links for now.

* Added ability to view tweets from the TechIsHiring Twitter account.

* Did some clean up to the app to improve SEO when launched. (#4)

* Forgot to add Twitter feed story.

* Started to do initial seo stuff.

* Added next-sitemap and test generated a sitemap.

* Implement the API layer (#7)

* Building the base api file.

* Building api statues file.

* Realized there was a React warning about uppercase in props and decided to quickly fix it.

* Tested an example api to make sure what I was doing was correct. Will need to update useApiStatus as it's current form doesn't allow for intellisense.

* Successfully added useApi hook.

* Created an example component to show how the api layer works and moved the example api and the component into their own example folder.

* Added a folder for endpoints and created a file with links to where I got this implementation.

* Renamed implemenation source file to references.txt.

* Adding an example of data fetching with the API layer that is nextjs specific.

* Restructuring api folder to be more explicit and clear of content.

* Create About page for TechIsHiring website (#9)

* Created card component and it's corresponding story.

* Updated Twitter feed to use card component.

* Added about page but getting a hydration error. Going to try and fix that right now.

* Fixed issue with hydration error. When using Chakra UI text, you need to use 'as' to make into into the appropriate html tag.

* Add posthog to website! (#8)

* changed .env variable to .env.local and added posthog id. Will add posthog id to server as well.

* Successfully added posthog to app.

* Added eslint to project (#10)

* Added eslint from next and formatted project.

* Forgot that stories were formatted weird.

* Implement newsletter page (#11)

* Added a basic endpoint for revue. Haven't tested yet.

* Tested issues api and did some clean up to make it more usable in TypeScript.

* Added subscribers api (not tested yet) and beginning putting together newsletter page.

* Working on newsletter page. Adding necessary atoms so I can begin to test api.

* Set up email entry. Can now test api.

* Created a subscribe to newsletter molecule and migrated the code from newsletter content there.

* Did some quick markup clean up.

* Pivoting to making a next api to send request to revue because of cors issue. Testing now.

* Got the api to work. Just need to clean up the app based on what the request sends back.

* Added different states for how the email response.

* Created newsletter entries organism to show the latest newsletters.

* Doing some clean up on project.

* Doing some quick clean up before full release. (#12)

* Fixing a bug where even though the api returned an error, the newsletter will say that it successfully went through.

* Made top nav stick to the top.

* Did active link for nav.

* Added example for building layouts

* Redid README file.

* Added better image for TechIsHiring logo.

* Pulled out newsletterentry from newsletter organism and made it a molecule.

* Updated README to add Design Document.

* Changed link to use next/link component and fixed some warnings throughout app.

* Changed a console.log to output a string instead of the error because the error had the API Key.

.eslintrc.json

@@ -0,0 +1,11 @@
+{
+  "extends": "next/core-web-vitals",
+  "rules": {
+    "comma-dangle": "error",
+    "quotes": "error",
+    "camelcase": "error",
+    "jsx-quotes": "error",
+    "semi": "error",
+    "indent": ["error", 2]
+  }
+}

README.md

@@ -2,30 +2,74 @@
 
 The website for TechIsHiring.com
 
-## Next.js + Tailwind CSS Example
+## Technologies Used
 
-This example shows how to use [Tailwind CSS](https://tailwindcss.com/) [(v3.0)](https://tailwindcss.com/blog/tailwindcss-v3) with Next.js. It follows the steps outlined in the official [Tailwind docs](https://tailwindcss.com/docs/guides/nextjs).
+* Next.js
+* Tailwind CSS
+* Chakra UI
+* TypeScript
+* Storybook
+* Axios
 
-## Deploy your own
+## Project Design Document
 
-Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-tailwindcss)
+This is a link to the Design Document for this project: [Design Document](https://drive.google.com/file/d/15jYKdhq1NcL4rHJIvBxoLUuNlYRqOhMr/view?usp=sharing)
 
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-tailwindcss&project-name=with-tailwindcss&repository-name=with-tailwindcss)
+## Atomic Design
 
-## How to use
+This project uses Atomic Design for it's Components. Here are several resources for Atomic Design if you are unfamiliar:
 
-Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
+* [Atomic Design by Brad Frost](https://bradfrost.com/blog/post/atomic-web-design/)
+* [Atomic Design - How To Make Web and UI Design Easier](https://www.youtube.com/watch?v=W3A33dmp17E)
 
-```bash
-npx create-next-app --example with-tailwindcss with-tailwindcss-app
+## Storybook
+
+The Stoybook for this project can be found at [https://design.techishiring.com](https://design.techishiring.com).
+
+### Run it locally
+
+```shell
+npm run storybook
+```
+
+## Local development
+
+To install the application:
+
+```shell
+npm ci
 ```
 
-```bash
-yarn create next-app --example with-tailwindcss with-tailwindcss-app
+To run the application on a developement server:
+
+```shell
+npm run dev
 ```
 
-```bash
-pnpm create next-app --example with-tailwindcss with-tailwindcss-app
+To reinstall your node_modules if a problem occurs with your dependencies:
+
+```shell
+npm run reset-deps
 ```
 
-Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
+### Code linting
+
+To check the code and styles quality, use the following command:
+
+```shell
+npm run lint
+```
+
+To fix the linting errors, use the following command:
+
+```shell
+npm run format
+```
+
+### Production deployment
+
+Run this command to build the project.
+
+```shell
+npm run build
+```

next-types.d.ts

@@ -1,3 +1,5 @@
+// Base Project Types
+
 interface Link {
   url: string;
   activeLink?: boolean;
@@ -6,4 +8,16 @@ interface Link {
 
 interface NavLink extends Link {
   text: string;
-};
+};
+
+// API Return Types
+
+// Revue
+
+readonly interface Issues {
+  id: number;
+  title: string;
+  description: string;
+  url: string;
+  send_at: string;
+}

next.config.js

@@ -1,4 +1,4 @@
 /** @type {import('next').NextConfig} */
 module.exports = {
-  reactStrictMode: true,
-}
+  reactStrictMode: true
+};