Merge branch 'v2'

Judge-Paul · Aug 21, 2023 · 13cd715 · 13cd715 · vercel · Aug 21, 2023
2 parents 864113c + 543dc6f
commit 13cd715
Show file tree

Hide file tree

Showing 4 changed files with 125 additions and 108 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,89 @@
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+<h1 align="center" id="title">CoverWriteAI</h1>
+
+<p align="center"><img src="https://socialify.git.ci/Judge-Paul/coverwrite-ai/image?description=1&amp;descriptionEditable=Generate%20Cover%20Letters%20Instantly&amp;font=Bitter&amp;issues=1&amp;language=1&amp;name=1&amp;owner=1&amp;pattern=Circuit%20Board&amp;stargazers=1&amp;theme=Dark" alt="project-image"></p>
+
+<p id="description">CoverWriteAI – your ultimate tool for effortlessly generating cover letters. Say goodbye to the arduous process of crafting cover letters from scratch. With CoverWriteAI you're just a few clicks away from your perfectly tailored cover letter.</p>
+
+<h2>⚙️ Installation and Configuration</h2>
+
+Use [npm](https://nodejs.org/en/download) to install package dependencies and run.
+
+```bash
+npm install
+npm run dev
+```
+
+Replace the process.env.API_KEY in the [server code](https://github.com/Judge-Paul/coverwrite-ai/blob/main/server/index.js#L12) with your own API key
+
+```javascript
+const API_KEY = process.env.API_KEY;
+// Replace with your own API key gotten from makersuite
+```
+
+<h2>💻 Built with</h2>
+
+Technologies used in the project:
+
+<img src="https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB" /> <img src="https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E" /> <img src="https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white" /> <img src="https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge&logo=vite&logoColor=FFD62E" /> <img src="https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white" /> <img src="https://img.shields.io/badge/Material%20UI-007FFF?style=for-the-badge&logo=mui&logoColor=white" /> <img src="https://img.shields.io/badge/GIT-E44C30?style=for-the-badge&logo=git&logoColor=white" /> <img src="https://img.shields.io/badge/Vercel-000000.svg?style=for-the-badge&logo=Vercel&logoColor=white" /> <img src="https://img.shields.io/badge/Framer-0055FF.svg?style=for-the-badge&logo=Framer&logoColor=white"/>
+
+<h2>🤝 Contributing</h2>
+
+Contributions are welcome! To contribute to this project, follow these steps:
+
+1. **Create an Issue**: Before starting work on a new feature, enhancement, or bug fix, it's recommended to create a new issue. This allows for discussions and feedback on the proposed changes. Issues help ensure that your contribution aligns with the project's goals and avoids duplication of effort.
+
+2. **Fork this repository**.
+
+3. **Create a new branch**: `git checkout -b feature/my-feature`.
+
+4. **Make your changes and commit them**: `git commit -am 'Add some feature'`.
+
+5. **Push the changes to your fork**: `git push origin feature/my-feature`.
+
+6. **Create a pull request**, explaining your changes.
+
+Please ensure that your pull request follows the project's coding guidelines and standards.
+
+### Creating an Issue
+
+When creating an issue, provide the following details:
+
+- A clear and descriptive title.
+- A detailed description of the problem or enhancement you are addressing.
+- Steps to reproduce (for bugs).
+- Any relevant code snippets or screenshots.
+
+By following these steps and creating an issue, you help maintain a structured development process and ensure that your contributions are aligned with the project's objectives.
+
+Thank you for your contributions!
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Judge-Paul"><img src="https://avatars.githubusercontent.com/u/110723341?v=4?s=100" width="100px;" alt="Judge-Paul Ogebe"/><br /><sub><b>Judge-Paul Ogebe</b></sub></a><br /><a href="https://github.com/Judge-Paul/coverwrite-ai/commits?author=Judge-Paul" title="Code">💻</a> <a href="https://github.com/Judge-Paul/coverwrite-ai/commits?author=Judge-Paul" title="Documentation">📖</a> <a href="https://github.com/Judge-Paul/coverwrite-ai/pulls?q=is%3Apr+reviewed-by%3AJudge-Paul" title="Reviewed Pull Requests">👀</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
diff --git a/client/README.md b/client/README.md
diff --git a/client/src/components/Navbar.jsx b/client/src/components/Navbar.jsx
@@ -1,6 +1,6 @@
 import React, { useState, useEffect } from "react";
 import Logo from "../assets/logo.png";
-import { Link } from "react-router-dom";
+import { Link, useNavigate } from "react-router-dom";
 import { IoClose, IoMenu } from "react-icons/io5";
 import { motion } from "framer-motion";
 
@@ -11,6 +11,17 @@ function Navbar() {
     hidden: { opacity: 0, y: -20 },
     visible: { opacity: 1, y: 0 },
   };
+  const navigate = useNavigate();
+  const links = [
+    { route: "/", name: "Home" },
+    { route: "/create", name: "Try It" },
+    { route: "/examples", name: "Examples" },
+    { route: "/about", name: "About" },
+  ];
+  useEffect(() => {
+    setIsOpen(false);
+    window.scrollTo(0, 0);
+  }, [navigate]);
   useEffect(() => {
     const handleScroll = () => {
       if (window.scrollY > 10) {
@@ -40,18 +51,15 @@ function Navbar() {
           <img src={Logo} alt="Logo" className="h-10 md:h-12" />
         </Link>
         <div className="hidden md:flex mt-2 text-[#3a4688] font-bold">
-          <Link to="/create" className="mx-4 lg:mx-7">
-            Try It
-          </Link>
-          <Link to="/examples" className="mx-4 lg:mx-7">
-            Examples
-          </Link>
-          <Link to="/about" className="mx-4 lg:mx-7">
-            About
-          </Link>
-          <Link to="/pricing" className="mx-4 lg:mx-7">
-            Pricing
-          </Link>
+          {links.map((link) => (
+            <Link
+              to={link.route}
+              className="mx-4 lg:mx-7"
+              onClick={() => setIsOpen(false)}
+            >
+              {link.name}
+            </Link>
+          ))}
         </div>
         <div className="md:hidden" onClick={() => setIsOpen(true)}>
           <IoMenu size={37} className="text-[#004fb6] cursor-pointer" />
@@ -63,33 +71,18 @@ function Navbar() {
           initial="hidden"
           animate="visible"
           variants={navAnimation}
-          className="md:hidden min-h-screen font-workSans w-screen fixed bg-[#9fcaff] text-[#3a4688] z-[9999] flex justify-center items-center"
+          className="md:hidden top-0 h-screen font-workSans w-screen fixed bg-[#9fcaff] text-[#3a4688] z-[9999] flex justify-center items-center"
         >
           <div className="font-bold text-center">
-            <Link
-              to="/create"
-              className="block my-3 text-lg hover:text-[#29306f]"
-            >
-              Try It
-            </Link>
-            <Link
-              to="/examples"
-              className="block my-3 text-lg hover:text-[#29306f]"
-            >
-              Examples
-            </Link>
-            <Link
-              to="/about"
-              className="block my-3 text-lg hover:text-[#29306f]"
-            >
-              About
-            </Link>
-            <Link
-              to="/pricing"
-              className="block my-3 text-lg hover:text-[#29306f]"
-            >
-              Pricing
-            </Link>
+            {links.map((link) => (
+              <Link
+                to={link.route}
+                className="block my-3 text-lg hover:text-[#29306f]"
+                onClick={() => setIsOpen(false)}
+              >
+                {link.name}
+              </Link>
+            ))}
             <button
               onClick={() => setIsOpen(false)}
               className="mt-5 flex mx-auto items-center justify-center w-12 h-12 rounded-full bg-[#3a4688] hover:bg-[#29306f]"

diff --git a/client/vercel.json b/client/vercel.json
@@ -0,0 +1,5 @@
+{
+    "rewrites":  [
+      {"source": "/(.*)", "destination": "/"}
+    ]
+}