Hardware City website

This is the source code for the Hardware City website.

With ❤️ from Hardware City

Getting Started

If you have any trouble getting started, reach out to us in our Discord or by email (see the MAINTAINERS file).

How to set up

Note

For an optimal developer experience, it is recommended to install Nix and direnv..

Installing Nix and direnv

Note: These are instructions that SHOULD work in most cases. Consult the links above for the official instructions for your OS.

Install Nix:

sh <(curl -L https://nixos.org/nix/install) --daemon

Consult the installation instructions to install direnv using your package manager.

On MacOS:

brew install direnv

Install from binary builds:

curl -sfL https://direnv.net/install.sh | bash

The last step is to configure your shell to use direnv. For example for bash, add the following lines at the end of your ~/.bashrc:

eval "\$(direnv hook bash)"

Then restart the shell.

For other shells, see https://direnv.net/docs/hook.html.

MacOS specific instructions

Nix may stop working after a MacOS upgrade. If it does, follow these instructions.

---

Otherwise, install the required dependencies.

Installing required dependencies

Install hugo following the instructions at Hugo's Website.

Install Node JS >= 18. You can use brew install node on MacOS. For other systems, search on Google or download the installer at https://nodejs.org/en/download/current.

---

Then initialize the project with:

make init

How to run

make run # then go to http://localhost:1313 on your browser

Community, discussion, contribution, and support

Contributions are made to this repo via Issues and Pull Requests (PRs). Opening an issue will show a set of templates and communication channels for you to use. If any part of the project has a bug or mistake, please let us know by opening an issue.

Code of conduct

By participating and contributing to this project, you agree to uphold our Code of Conduct.