This repository has moved to dothq/www
Dot HQ (dothq.co)
Welcome to the Dot HQ Web Stack. Our web pages are in pages/
, the assets are at src/images
, fonts are at src/fonts
and the API is at api
.
Have an idea for our website? You can drop a suggestion in our Discord server or create an issue in this repo.
🚀 Running web locally
-
Clone the repo
If you have Git installed, this should be an easy task.
# cloning our repo... git clone https://git.dothq.co/dothq.co.git
-
Install dependencies
We recommend using Yarn instead of npm, as npm causes issues with Gatsby.
cd dothq.co yarn
-
Run the development server
Once all the dependencies have installed without errors, run the following commands in your terminal.
# Developing the frontend yarn develop:web # Developing the api yarn develop:api
-
Start hacking
You should see a message in the terminal like this:
You can now view dothq.co in the browser. ⠀ http://localhost:8000/ ⠀ View GraphiQL, an in-browser IDE, to explore your site's data and schema ⠀ http://localhost:8000/___graphql ⠀ Note that the development build is not optimized. To create a production build, use gatsby build
The site is now running and you can visit in your browser of choice (hopefully Dot Browser) at
localhost:8000/
. If the port is different in the above message, you can substitute:8000
for what it says above.
📄 Additional files
To develop the frontend you will need a file called dot.credentials.ts
. This can contain personal information so is never pushed to git. You can bypass this by creating a file with the same name and adding the following contents:
export default {}
🎓 Learning Gatsby
Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:
-
For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.
-
To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.