Project-Badam

Project Badam is a web application designed to reduce the stress and hassle of building a resume for students of the National Institute of Technology (NIT) Rourkela. This project is built using Vite, a fast and efficient web development build tool, and utilizes Tailwind CSS for easy and responsive styling.

Installation

1. Fork this repo
2. Clone the repository: git clone https://github.com/your-username/nitr-resume-generator.git
3. Navigate to the project directory: cd project-badam
4. Install the dependencies: yarn install

Usage

1. Start the development server: yarn dev
2. Open your web browser and navigate to http://localhost:3000

Technologies Used

• Vite: A fast and opinionated web development build tool.
• Tailwind CSS: A utility-first CSS framework for rapid UI development.
• JavaScript: The programming language used for the application logic.
• HTML: The markup language used to structure the web pages.
• CSS: The styling language used to customize the appearance of the web application.

Contributing

Contributions to project badam are welcome! If you want to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch: git checkout -b my-new-branch
3. Make your changes and commit them. Follow the commit standards.
4. Push your branch to the remote repository: git push origin my-new-branch.
5. Open a pull request on GitHub or your chosen Git hosting platform, comparing your branch to the main branch. Please ensure that your pull request follows the project's code style and includes relevant tests.

Commit Standards

1. Specify the type of the commit using one of the following:
   • feat: A new feature or enhancement.
   • fix: A bug fix.
   • style: Style-related changes (e.g., formatting, code style).
   • chore: Routine tasks, maintenance, or tooling-related changes.
   • refractor: Refactoring production code, eg. renaming a variable
   • perf: Code to improve the performance of the present code
   • docs: Change the documentation of the repository
2. Start the commit message with a succinct summary that clearly describes the purpose of the commit.
3. Provide more specific details about the changes made in the commit, using bullet points if necessary.
4. Reference any related issue(s) in the commit message.
5. Include any additional notes or information that may be relevant to the commit.