Skip to content

Latest commit

 

History

History
81 lines (46 loc) · 3.94 KB

README.md

File metadata and controls

81 lines (46 loc) · 3.94 KB

All 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 to install package dependencies and run.

npm install
npm run dev

Replace the process.env.API_KEY in the server code with your own API key

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!

📸 Screenshots

Home Page

screenshot1

Create Page

screenshot2

👬 Contributors

License

Apache