OpenSubdomains

OpenSubdomains is a service that helps developers get clean and professional-looking domains for their personal websites.

Inspired by these amazing services: is-a.dev and Open Domains.

---

🚀 Register a Domain

Follow these steps to register your domain:

1. Create your account at our service:

• How?
  • Go to this website.
  • Click Login with GitHub and follow the instructions to grant the required permissions.
  • Once authorized, you will gain access to your domains (subdomains), etc.

2. Star this repository.
3. Fork this repository.
4. Add your subdomain to the domains/ directory in a new file named <your-subdomain>.json. Ensure your file follows this structure:

   {
      "domain": "is-a.dev",
      "subdomain": "example",
      "owner": {
         "repo": "https://github.com/your-repo",
         "email": "your-email@example.com"
      },
      "record": {
         "CNAME": "your-github-pages-url"
      }
   }

5. Create a pull request with your changes.
6. Wait for approval
7. When you got approved, go back to our website
8. Login and find your domain (subdomain)
9. Click validate button and watch your domain go live! 🎉

!NOTICE!

This service is still in maintence, so nothing will be accepted at this moment

📄 License

OpenSubdomains is licensed under the GPL-3.0 license.

🆘 Issue

If you have any problems, feel free to open an issue.