From e05a777d7079d2fd30503fc8f385bcd03ade00d6 Mon Sep 17 00:00:00 2001 From: Judge-Paul Date: Mon, 21 Aug 2023 23:01:55 +0100 Subject: [PATCH 1/2] ch: project changes --- README.md | 89 ++++++++++++++++++++++++++++++++++++++++++++++ client/README.md | 70 ------------------------------------ client/vercel.json | 5 +++ 3 files changed, 94 insertions(+), 70 deletions(-) create mode 100644 README.md delete mode 100644 client/README.md create mode 100644 client/vercel.json diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4aa927 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ + + +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) + + +

CoverWriteAI

+ +

project-image

+ +

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.

+ +

⚙️ Installation and Configuration

+ +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 +``` + +

💻 Built with

+ +Technologies used in the project: + + + +

🤝 Contributing

+ +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)): + + + + + + + + + + +
Judge-Paul Ogebe
Judge-Paul Ogebe
💻 📖 👀
+ + + + + + +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 deleted file mode 100644 index 92710e9..0000000 --- a/client/README.md +++ /dev/null @@ -1,70 +0,0 @@ - - -[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) - -# CoverWriteAi - -CoverWriteAI is a website that leverages the power of AI and GPT-3 technology to help job seekers create professional and personalized cover letters in a matter of minutes. Our platform is designed to simplify the job application process and help you stand out from the crowd by generating custom cover letters that match your experience and qualifications. - -## Installation - -Use the package manager [npm](https://www.npmjs.com/) and run - -```bash -npm install -npm run dev -``` - -## Dependencies -npm will install the following dependencies - -- @emotion/react -- @emotion/styled -- @mui/material -- axios -- dotenv -- framer-motion -- jspdf -- openai -- react -- react-copy-to-clipboard -- react-dom -- react-icons - -## Usage -![ezgif com-crop](https://user-images.githubusercontent.com/110723341/218100683-7e0c7666-cdf2-4852-81a4-bc50af7b44ba.gif) - -## Contributing -### Contributors (People with edit access) -Checkout any change you are making to a new branch then create a pull request for that branch to be merged - -### Non Contributors (People without edit access) -Pull requests are welcome. For major changes, please open an issue first or message me on [twitter](https://twitter.com/paulogebe) to discuss what you would like to change. - -## Technologies - -## License - -[MIT](https://choosealicense.com/licenses/mit/) - -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - -
Judge-Paul Ogebe
Judge-Paul Ogebe
💻 📖 👀
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file diff --git a/client/vercel.json b/client/vercel.json new file mode 100644 index 0000000..3f87eef --- /dev/null +++ b/client/vercel.json @@ -0,0 +1,5 @@ +{ + "rewrites": [ + {"source": "/(.*)", "destination": "/"} + ] +} \ No newline at end of file From 543dc6fa03d331f60ee940c9f983e1001a847fc1 Mon Sep 17 00:00:00 2001 From: Judge-Paul Date: Tue, 22 Aug 2023 00:16:04 +0100 Subject: [PATCH 2/2] fix: all navigation bugs --- client/src/components/Navbar.jsx | 69 ++++++++++++++------------------ 1 file changed, 31 insertions(+), 38 deletions(-) diff --git a/client/src/components/Navbar.jsx b/client/src/components/Navbar.jsx index 13ae85b..2753fbe 100644 --- 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() { Logo
- - Try It - - - Examples - - - About - - - Pricing - + {links.map((link) => ( + setIsOpen(false)} + > + {link.name} + + ))}
setIsOpen(true)}> @@ -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" >
- - Try It - - - Examples - - - About - - - Pricing - + {links.map((link) => ( + setIsOpen(false)} + > + {link.name} + + ))}