|
| 1 | +--- |
| 2 | +icon: rocket |
| 3 | +label: Quick Start |
| 4 | +route: /quickstart |
| 5 | +tags: useful |
| 6 | +--- |
| 7 | + |
| 8 | +# Requirements before starting |
| 9 | + |
| 10 | +Before you start the process of making a is-a.dev domain, make sure you have the following: |
| 11 | + 1. You have a website that is at least somewhat complete. It should not be blank or have very little information. |
| 12 | + 2. Make sure the website is a personal website (like a portfolio or a blog that's software development related) or a non-commercial project that's software development related. |
| 13 | + 3. Make sure the website isn't for commercial purposes; if the website is for commercial purposes, we have the right to close the pull request. You can read our Terms of Conditions [here](https://is-a.dev/terms). |
| 14 | + |
| 15 | +After you've made sure that you meet these requirements, we can continue with the process of making a is-a.dev domain. |
| 16 | + |
| 17 | +# Making the is-a.dev domain |
| 18 | + |
| 19 | +Now, to make the file in the first place before making a pull request, you have to fork [our repository](https://github.com/is-a-dev/register). You can click the link [here](https://github.com/is-a-dev/register/fork) to do so. |
| 20 | + |
| 21 | +After you've forked our repository, you can start making the file for your domain. To make the file, enter your fork of our repository (which you should already be there), enter the `domains` directory, also known as a folder, and create the file from there. |
| 22 | + |
| 23 | +You may be wondering, "How should I name the file?" The filename should be the domain name you want in lowercase followed by the JSON extension (.json) at the end of the filename, so it would be something like this: `subdomain.json` (Replace `subdomain` with the name you want to register, of course). For more information about what filenames are valid or invalid, click [here](https://docs.is-a.dev/domain-structure/#-filename-guidelines). |
| 24 | + |
| 25 | +After you've finished with the filename, you can start making the file format of the JSON file. Depending on your hosting provider, we have guides for most hosting providers (like GitHub Pages, Cloudflare Pages and Vercel, just to name a few) accessible in our documentation, but for hosting providers that don't have a guide, you should pay attention to what records they provide. An example of a valid file format is the one listed below, though you can also check out the [Domain Structure](useful/domain-structure) section to see what records we support. |
| 26 | + |
| 27 | +```json |
| 28 | +{ |
| 29 | + "owner": { |
| 30 | + "username": "your-github-username" |
| 31 | + }, |
| 32 | + "records": { |
| 33 | + "CNAME": "example.org" |
| 34 | + } |
| 35 | +} |
| 36 | +``` |
| 37 | + |
| 38 | +!!! |
| 39 | +You should replace the placeholder username with your own GitHub username and the placeholder records with the valid records your hosting provider gave while trying to connect the domain. |
| 40 | +!!! |
| 41 | + |
| 42 | +When you've made sure that you have the valid file format and the correct filename, you can now start making a pull request. If you aren't sure if the JSON format is valid, you can check with [jsonlint](https://jsonlint.com/). |
| 43 | + |
| 44 | +## Making the pull request |
| 45 | + |
| 46 | +Assuming you know how GitHub works, it should be easy for you to make a pull request to our repository. For those who don't know how to make one, you can check [this guide from GitHub's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on how to do it. |
| 47 | + |
| 48 | +Before you create the pull request, make sure that you've read the pull request template and have completed it with the right information in order to save both your time and our (the maintainers') time. |
| 49 | + |
| 50 | +!!!danger |
| 51 | +Please don't replace the pull request template with something else, since that could result in your pull request being closed instantly when a maintainer sees it. Please also add a preview of your website with both the link to your website and a screenshot of your website in the pull request description. |
| 52 | +!!! |
| 53 | + |
| 54 | +When you've completed it, you can create the pull request and wait for the maintainers to review it. Make sure to also check the pull request from time to time to see if there's any chances that need to be made. |
| 55 | + |
| 56 | + |
| 57 | +# What do I do now? |
| 58 | + |
| 59 | +When your pull request has been merged by a maintainer, you have to make sure that you've connected the domain with your website, or else it won't work. Go to your website's settings and add the domain from there to make sure you've added it. After you've connected the domain, you are good to go! Now you can enjoy your is-a.dev domain. If you have any questions then you can either make a GitHub issue on our main repository or [join our Discord server](https://discord.gg/is-a-dev-830872854677422150) and ask there. You can also read our [FAQ](useful/faq) since we should have most of the common questions answered there. |
0 commit comments