README.md

Contribution Cards

Welcome to Contribution Cards! This project lets you design and customize HTML cards, making it a fantastic way to dive into open-source contributions, sharpen your HTML, CSS, JS, TailWindCSS, and Git skills, and unleash your creativity. Whether you're just starting out or you're a seasoned developer, there's something here for everyone! 🤍🤝

Tech Stack

Frontend
CI/CD

Table of Contents

• Getting Started
• How to Contribute
  • Fork the Repository
  • Clone the Repository
  • Create a Branch
  • Make Your Changes
  • Commit Your Changes
  • Push to GitHub
  • Create a Pull Request
• Project Structure
• Contributors
• License

Getting Started

Ready to jump in? Follow these steps to get started with Contribution Cards:

1. Fork this repository: Click the 'Fork' button at the top right of this page.
2. Clone your forked repository:

   git clone https://github.com/your-username/contribution-cards.git

3. Navigate into the project directory:

   cd contribution-cards

4. Update your card details in users.json in the data directory:

   {
     "name": "John Doe",
     "title": "Software Developer",
     "socialLinks": {
       "linkedin": "https://www.linkedin.com/in/johndoe",
       "github": "https://github.com/johndoe",
       "portfolio": "https://johndoe.com"
     },
     "description": "John is a software developer passionate about open-source projects and community engagement.",
     "studyLinks": {
       "freeCodeCamp": "https://www.freecodecamp.org",
       "w3Schools": "https://www.w3schools.com",
       "githubDocs": "https://docs.github.com"
     },
     "updatedOn": "July 22, 2024"
   }

How to Contribute

We welcome contributions from everyone. Here's how you can get involved:

Fork the Repository

1. Click the 'Fork' button at the top right corner of the repository page.

Clone the Repository

2. Clone your forked repository to your local machine:

   git clone https://github.com/your-username/contribution-cards.git

Create a Branch

3. Create a new branch for your changes:

   git switch -c "your-branch-name"

Make Your Changes

4. Make your changes to the project. This might include editing HTML, CSS, or JavaScript files.

Commit Your Changes

5. Add and commit your changes with a meaningful commit message:

   git add .
   git commit -m "Add a meaningful commit message"

Push to GitHub

6. Push your changes to your forked repository:

   git push origin your-branch-name

Create a Pull Request

7. Create a pull request from your forked repository to the original repository. Click the 'New Pull Request' button on the original repository's page and follow the instructions.

Project Structure

Here's a brief overview of the project structure:

├── assets
├── CODE_OF_CONDUCT.md
├── Contributors.md
├── data
│   └── users.json
├── index.html
├── js
│   └── main.js
├── MIT-LICENSE.txt
└── README.md

Contributors

We appreciate the contributions of the following individuals: Contributors

This is just the beginning! We look forward to making more meaningful contributions and collaborating with this amazing community. Let's build something great together and make Contribution Cards the best it can be! ❤️🤝

License

This project is licensed under the MIT License. See the LICENSE file for details.