Skip to content

Latest commit

 

History

History
111 lines (80 loc) · 2.57 KB

README.md

File metadata and controls

111 lines (80 loc) · 2.57 KB
Raw

mAfi (Me And First Issue)

mAfi Logo

Find Your First Open Source Contribution

A modern platform to discover and track "good first issues" in open source projects.

🚀 About mAfi

mAfi (Me And First Issue) is a web application designed to help developers find their first open source contributions. It aggregates "good first issues" from GitHub repositories, making it easier for newcomers to start their open source journey.

Features

  • 🔍 Browse through curated "good first issues"
  • ⭐ Save favorite issues for later
  • 🏷️ Filter issues by labels and difficulty
  • 🎯 Real-time GitHub integration
  • 📱 Responsive design for all devices

🛠️ Tech Stack

  • React 18
  • TypeScript
  • Vite
  • TailwindCSS
  • React Query
  • React Router
  • GitHub API
  • Lucide Icons

🚀 Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn
  • Git

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/mafi.git
cd mafi
  1. Install dependencies:
npm install
# or
yarn install
  1. Create a .env file in the root directory:
GITHUB_TOKEN=your_github_token_here
  1. Start the development server:
npm run dev
# or
yarn dev

The application will be available at http://localhost:5173

🤝 Contributing

We welcome contributions from everyone! Here's how you can help:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Development Guidelines

  • Follow the existing code style and conventions
  • Write meaningful commit messages
  • Update documentation as needed
  • Add comments for complex logic
  • Test your changes thoroughly

📝 Code of Conduct

Please read our Code of Conduct before contributing to the project.

📜 License

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

🙏 Acknowledgments

  • Thanks to all contributors who help improve mAfi
  • GitHub API for making this possible
  • The open source community for inspiration

🔗 Links

Made with ❤️ for the open source community