git.iko.soy/urbit.org
on alangalis-add-elm help sign in
urbit.org/README.md
58 lines 1.9 kB history raw
1The website for Urbit is maintained by the Urbit Foundation and the Urbit community. Issues and contributions are welcome.
3## Getting Started
51. Fork the [Urbit site repository](https://github.com/urbit/urbit.org).
72. [Create a local clone](https://help.github.com/articles/cloning-a-repository/) of your fork.
93. Navigate to the `urbit.org` directory and install Node 14 using [nvm](https://github.com/nvm-sh/nvm):
11 ```shell
12 cd urbit.org
13 nvm install 14
14 ```
15 You can then run `nvm use` whenever in the repository (or automate it with a script - see [here](https://github.com/nvm-sh/nvm#deeper-shell-integration)).
174. Install our dependencies:
19 ```shell
20 npm install
21 ```
23 If running an arm64 Mac (M1 or later), you may need to install some dependencies to compile canvas, one of our dependencies. Assuming you have [Homebrew](https://brew.sh):
25 ```shell
26 arch -arm64 brew install pkg-config cairo pango libpng jpeg giflib librsvg
27 ```
295. Run the development server:
31 ```shell
32 npm run dev
33 # or
34 yarn dev
35 ```
37 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
39To learn more about contributing, see GitHub's [documentation](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
41## Framework and Library Documentation
43To learn more about Next.js, take a look at the following resources:
45- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
46- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
48To learn more about Tailwind CSS, take a look at the docs:
50- [Tailwind CSS Docs](https://tailwindcss.com/docs) - Docs
52## Deployment
54We deploy using Vercel. All pull requests will show a deployment preview via the same.
56## Upgrades
58The `/scripts` contains scripts used to programmatically upgrade site content data.