README.md

AccioINTERN

A platform for internship project submissions and organization invitations.

Table of Contents

• About
• Features
• Setup
• Contributing
• License

About

AccioINTERN is a platform designed to streamline the process of internship project submissions and organization invitations. It allows users to submit their projects and receive invitations to join a GitHub organization automatically.

Features

• User-friendly Interface: Simple form-based submission for GitHub usernames.
• Automated Invitations: GitHub Actions workflow sends organization invitations.
• Scalable: Easily adaptable for different organizational needs.

Setup

To get started with AccioINTERN, follow these steps:

1. Clone the repository:

   git clone https://github.com/AccioINTERN/acciointern.github.io.git
   cd acciointern.github.io
   

2. Configure GitHub Actions:

   • Edit .github/workflows/invite.yml with your organization name and setup secrets for GITHUB_TOKEN.

3. Deploy Serverless Function:

   • Deploy api/join.js to handle GitHub invitation requests.

4. Host the Static Website:

   • Host index.html on GitHub Pages or any web hosting service.

5. Customize:

   • Customize the UI and functionality based on your organization's needs.

Contributing

Contributions are welcome! Please follow these guidelines:

• Fork the repository and create your branch (git checkout -b feature/your-feature).
• Commit your changes (git commit -am 'Add some feature').
• Push to the branch (git push origin feature/your-feature).
• Create a new Pull Request.

License

This project is licensed under the CC BY-SA 4.0 License - see the LICENSE file for details.