|
1 | 1 |  |
2 | 2 |
|
3 | 3 | [](LICENSE) |
| 4 | +[](https://github.com/vanityURLs/code/releases/latest) |
4 | 5 | [](.github/CODE_OF_CONDUCT.md) |
5 | 6 | [](#contributors) |
6 | 7 |
|
7 | 8 | vanityURLs is a Cloudflare Workers redirector for running a branded short-link domain as code. Links, schedules, |
8 | 9 | destination policies, localized instance pages, and operator configuration live in Git; the build produces the Worker |
9 | 10 | assets that Cloudflare deploys. |
10 | 11 |
|
11 | | -## Documentation |
12 | | - |
13 | | -The website is the source of truth for setup and operations: |
14 | | - |
15 | | -- [Getting started](https://www.VanityURLs.link/en/docs/getting-started/) |
16 | | -- [Customize your instance](https://www.VanityURLs.link/en/docs/customize-overview/) |
17 | | -- [Local CLI](https://www.VanityURLs.link/en/docs/cli/) |
18 | | -- [Full documentation](https://www.VanityURLs.link/en/docs/) |
| 12 | +The [documentation](https://vanityurls.link/en/docs/setup/) on the website is the source of truth for setup and |
| 13 | +operations. |
19 | 14 |
|
20 | 15 | ## Quickstart |
21 | 16 |
|
22 | 17 | Before starting, you need a registered short domain, GitHub and Cloudflare accounts, Git, Node.js 20 or newer, npm, and |
23 | 18 | a text editor. The short domain must use Cloudflare as its authoritative DNS provider before the Worker can serve it. |
24 | 19 |
|
25 | | -Clone the vanityURLs code, detach the clone from the upstream project, then install dependencies: |
26 | | - |
27 | | -```bash |
28 | | -git clone https://github.com/vanityurls/code.git redirector |
29 | | -cd redirector |
30 | | -npm run detach |
31 | | -npm install |
32 | | -``` |
33 | | - |
34 | | -Run the installer, install local helpers, then validate the plain instance: |
35 | | - |
36 | | -```bash |
37 | | -npm run setup |
38 | | -npm run local-install |
39 | | -npm run check |
40 | | -``` |
41 | | - |
42 | | -Review `wrangler.toml` and set the Worker name plus the route or custom domain for your short domain. Keep |
43 | | -instance-specific files in `custom/`; do not edit `defaults/` unless you are contributing upstream changes to vanityURLs |
44 | | -itself. |
45 | | - |
46 | | -Initialize Git, push the repository to GitHub, and connect it to Cloudflare Workers & Pages. You can also deploy |
47 | | -manually: |
48 | | - |
49 | | -```bash |
50 | | -npx wrangler deploy --config wrangler.toml |
51 | | -``` |
52 | | - |
53 | | -After the first redirect works, use the documentation to customize branding, legal pages, analytics, protected |
54 | | -dashboards, and local workstation helpers. |
55 | | - |
56 | | -## Local Workflow |
57 | | - |
58 | | -Run `npm run setup` first to configure the instance, then `npm run local-install` to install workstation helpers. Run |
59 | | -`npm run local-publish` after local edits when you want checks, commit selection, and push handled in one step. Run |
60 | | -`./scripts/v8s-lnk --help` for the local link-management quick reference. `./scripts/lnk` remains a compatibility alias. |
61 | | - |
62 | | -Command prefixes are grouped: `npm run test`, `npm run validate`, and `npm run smoke` run their whole group, while |
63 | | -focused variants such as `test:worker`, `validate:targets`, and `smoke:analytics` run one layer. Run `npm run help` for |
64 | | -the full command list and rationale. |
| 20 | +Follow the [documentation](https://vanityurls.link/en/docs/quickstart) to spin your vanityURLs' instance. |
65 | 21 |
|
66 | 22 | ## Contributions |
67 | 23 |
|
|
0 commit comments