/bright-resume

The open source resume builder on GitHub is a powerful tool for job seekers who want to create professional and polished resumes. This project is free to use and customizable to fit the unique needs of each individual user.

Primary LanguageTypeScript

Bright Resume Builder

Bright Resume Logo

License

Resume Builder is an open-source tool that allows you to create professional resumes easily. With its customizable templates and intuitive interface, you can generate impressive resumes tailored to your needs. This project aims to simplify the resume creation process and provide a portable solution that you can run anywhere.

Features

  • Template Customization: Choose from a range of professionally designed templates and customize them to suit your preferences.
  • Flexible Sections: Easily modify and reorder sections such as education, work experience, skills, and more.
  • Export to PDF: Export the resume as a PDF or share it online.
  • Collaboration: Share your resume with others for feedback and suggestions, fostering a collaborative resume-building process.
  • Portability: Run the Bright Resume Builder on any platform or environment, making it convenient for your resume creation needs.

Installation

  1. Clone the repository: https://github.com/ErfanSeidipoor/bright-resume.git
  2. Installing Nx Globally yarn global add nx@latest or npm install --global nx@latest
  3. Navigate to the project directory: cd bright-resume
  4. Install dependencies: yarn add or npm install
  5. Start the application: npx nx serve <name-of-project>

Contributing

We welcome contributions from the open-source community! To contribute to the Bright Resume Builder project, follow these steps:

  1. Fork the repository and clone it locally.
  2. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name.
  3. Make your modifications and test thoroughly.
  4. Commit your changes: git commit -am 'Add new feature'.
  5. Push to the branch: git push origin feature/your-feature-name.
  6. Create a pull request, detailing your changes and their benefits.

Please ensure your code adheres to our coding guidelines and includes appropriate documentation.

For More Information on Linking a Pull Request

Please refer to the following link for detailed information on how to link a pull request to an issue in GitHub:

Linking a Pull Request to an Issue - GitHub Docs

This documentation provides step-by-step instructions and explanations on the process of linking a pull request to an issue. By following these guidelines, you can establish a clear connection between the code changes in a pull request and the corresponding issue, ensuring effective tracking and collaboration within your project.

Take a look at the documentation to learn more about this feature and how to leverage it for better project management.

Project Structure

The project follows the NX monorepo architecture, which allows for a modular and scalable codebase. The main folders in the project are:

  • apps: Contains the main applications.
    • web: The main Bright Resume application.
  • libs: Contains shared libraries and utility modules that can be used across different applications or libraries.
    • components: A library with reusable UI components for building the resume.
    • assets: A library containing all assets likes fonts, images,.
  • tools: Contains various tools or scripts related to the project.

Issues and Bug Reports

If you encounter any issues or bugs while using the Bright Resume application, please [open-an-issue] on our GitHub repository. We appreciate your feedback and will do our best to address the problems promptly.

License

Bright Resume Builder is released under the MIT License.

Acknowledgements

We would like to express our gratitude to the open-source community for their valuable contributions and support in making this project possible.


Feel free to explore the Bright Resume Builder, create stunning resumes, and contribute to its development. Together, we can empower individuals to present their qualifications effectively and build brighter career paths.