summaryrefslogtreecommitdiff
path: root/README.md
blob: e688080e8702a2786a381f86c1ae5ef77cd8ba6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Domain Name Hack Club

**https://namehack.club** - An exclusive club of geeks that own the domain hack to their name.

## Criteria

- Own the [domain hack](https://en.wikipedia.org/wiki/Domain_hack) for your name, e.g. [https://yuv.al](https://yuv.al)
- Serve an active **personal** homepage from that domain, both naked and subdomains (such as `www.`) are allowed

## Join the club

Open a new pull request to this repository that adds a new YAML file to the [`src/content/names`](src/content/names) directory.

If your domain name is `examp.le` the file name should be `examp.le.yml`, and the following minimal fields are required:

```yaml
domain: examp.le
name: Example Foo
title: A short title describing Example # maximum 80 chars
```

Other optional fields are supported:

```yaml
domain: examp.le
name: Example Foo
title: UI/UX designer # maximum 80 chars
url: https://examp.le/about/ # use to specify homepage URL if differs from https://examp.le
email: hi@examp.le
github: examplefoo
candidate: true # candidates that have not yet explicitly approved
invalid: true # used to mark e.g. broken or expired domains
```

Candidates are links to users who have not yet explicitly added their `name` and `title` to the list.

## Development

Local development requires [Node.js](https://nodejs.org/) and npm installed.

```bash
$ npm install
$ npm run dev
```

Other available commands:

```bash
$ npm run build    # Build for production
$ npm run preview  # Preview production build locally
```

## Deployment

Handled automagically on Cloudflare.