https://github.com/roneoorg/hello-comma-website
https://github.com/roneoorg/hello-comma-website
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/roneoorg/hello-comma-website
- Owner: RoneoOrg
- License: mit
- Created: 2021-08-03T23:39:01.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-03T23:39:33.000Z (almost 5 years ago)
- Last Synced: 2025-07-14T02:13:19.044Z (11 months ago)
- Language: SCSS
- Size: 42.8 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Overview
The codebase of [Hello, Comma](https://www.hellocomma.org).
The website is built with [Hugo](https://gohugo.io/) and [Wowchemy](https://wowchemy.com/).
Hello, Comma was created by and is primarily developed by [Andrew Nguyen](https://hellocomma.net/author/andrew-nguyen/).
# Development Environment
Hello, Comma is primarily developed on the Windows Subsystem for Linux using Ubuntu. Visual Studio Code is the main editor and the website is hosted with Netlify.
# Setup on Windows
## Step 1: Install a Text Editor
- We recommend [Visual Studio Code](https://code.visualstudio.com/)
## Step 2: Install the Windows Subsystem for Linux
- Install the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
## Step 3: Install Ubuntu
- Install [Ubuntu](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6)
## Step 4: Install Homebrew
- In a Ubuntu terminal, install [Homebrew](https://docs.brew.sh/Homebrew-on-Linux)
- If you run into errors, you may try either/or before installation:
- `sudo apt update`
- `sudo apt-get install build-essential`
## Step 5: Install Hugo
- In a Ubuntu terminal, install [Hugo](https://gohugo.io/getting-started/installing#linuxbrew-linux)
## Step 6: Setup Git
- Follow [these instructions](https://help.github.com/en/github/getting-started-with-github/set-up-git)
- For command line access, you may need to [setup a personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
## Step 7: Clone the project
### Owner/Collaborator
- In a Ubuntu terminal, setup your preferred project directory
- `e.g.: ~/GitHub/`
- In a terminal, execute:
- `git clone https://github.com/Kashinoga/hello-comma-website.git`
### Contributor
- Follow [these instructions](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
## Step 8: Setup Quick Access in the Windows File Explorer
- Pin the Ubuntu folder to Quick Access by navigating to this address in the File Explorer:
- `\\\wsl\$\Ubuntu`
- This helps with managing files using the File Explorer in Windows
# Collaboration and Contribution Guidelines
- Follow the [GitHub flow](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/github-flow) and [GitHub collaboration document](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)
# Discord
- Join our [Discord](https://discord.gg/3xKsXeg) for discussions and updates
# Reference
- [GitHub](https://github.com/Kashinoga/hello-comma-website)
- [Hugo](https://gohugo.io/)
- [Markdown](https://www.markdownguide.org/cheat-sheet/)
- [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
- [Wowchemy](https://sourcethemes.com/wowchemy/)