Civic Tech DC Website

Welcome! This is the repository for the website for Civic Tech DC. It is a static site built with Jekyll. It is mostly HTML, Javascript, and CSS.

Getting Started

Quickstart with Codespaces

Github Codespaces is a free development environment based on VS Code that is run entirely in the browser. You can have your own copy of the Civic Tech DC Website up and running in a few clicks.

1. Click "Fork" to make your own copy of the repository
   
2. Click "Create codespace on main"
   
3. Wait while your new Codespace starts, the dependencies will be installed and the web server will start automatically.
   
4. Click "Open in browser" to see your website running live! Click "Make public" if you would like to share with another user.
   
5. You can now modify the code and the website will automatically update.
6. Commit your changes as usual, and open a pull request when ready to share back with the team.

Local Development

1. First, make sure that you have git on your computer. Create your own fork of the repository, then clone it to your computer:

git clone [email protected]:[YOUR GITHUB NAME]/codefordc-website

2. Now, install the correct version of Ruby.

We use asdf and its ruby plugin to configure Ruby for this project. You can see which version of Ruby we're using in the .tool-versions file.

First, if you're on Ubuntu, you may need to install some dependencies. If the install step doesn't work, try one or both of these commands:

sudo apt install libyaml-dev
sudo apt install libffi-dev

To install the Ruby plugin, run the following commands inside the project's directory:

asdf plugin add ruby https://github.com/asdf-vm/asdf-ruby.git
asdf install

3. Install dependencies.

bundle install npm install

4. Run a local version of the website.

This command will run gulp as a background process and then jekyll as a foreground process.

npm run serve

5. Open a web browser page at localhost:4000

Issues

If you notice a problem or have an idea for an improvement you can submit an issue.

Contributing

Refer to the contribution instructions to contribute to this project. We have a project board where we track issues and ideas to be implemented.

Let us know if you get stuck in the Civic Tech DC Slack channel #civictechdc-website. Happy coding!