README.md

SquareStack - Invite

Join our organization in a few clicks

---

🔩 Usage

1. Clone the repository (git clone https://github.com/squarestack/github-invite.git)
2. Install dependencies with pnpm i or npm i
3. Create Github Personal Access Token with admin:org scope (see Creating a personal access token)
4. Copy .env.example to .env and fill it with your data (see .env file section)
5. Run pnpm run deploy to deploy the app or pnpm run dev to run it locally

🗜️ .env file

ORGANIZATION = "GITHUB_ORG" # Organization name
GITHUB_TOKEN = "GITHUB_PAT" # Personal Access Token
TEAM_ID = "GITHUB_TEAM_ID" # optional

Note

You can get your team id by going to https://api.github.com/orgs/{ORGANIZATION}/teams and finding your team (requires authentication), read more here

⁉️ Issues

If you come across any errors or have suggestions for improvements, please create a new issue here and describe it clearly.

📥 Pull Requests

When submitting a pull request, please follow these steps:

• Clone this repository https://github.com/squarestack/github-invite.git
• Create a branch from main and give it a meaningful name (e.g. my-awesome-new-feature).
• Open a pull request on GitHub and clearly describe the feature or fix you are proposing.

📋 License

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

📃 License

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