https://github.com/alicewriteswrongs/site

it's my website! wow!
https://github.com/alicewriteswrongs/site

Last synced: 21 days ago
JSON representation

it's my website! wow!

• Host: GitHub
• URL: https://github.com/alicewriteswrongs/site
• Owner: alicewriteswrongs
• Created: 2016-05-04T02:05:32.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-06-01T21:00:46.000Z (over 7 years ago)
• Last Synced: 2024-10-27T16:58:12.376Z (3 months ago)
• Language: Go
• Homepage: https://aliceriot.github.io
• Size: 56.8 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Website

[![Build

Status](https://travis-ci.org/aliceriot/site.svg?branch=master)](https://travis-ci.org/aliceriot/site)

This is my personal website. It's hosted

[here](https://aliceriot.github.io/).

It's a static site built with React, Redux, React-Router, and a bunch of

node scripts to build + deploy things.

There's a Rakefile to automate building markdown files from the Go source

(you need to already have

[mark_set_go](https://github.com/aliceriot/mark_set_go) installed). It

takes the formatted Markdown, renders it to HTML, and then saves it all to

JSON (for easy use in JS).

I started the site to document my progress in learning Go by doing the

Matasano crypto problemset, and ended up moving over my blog and a couple

of other things.

## Building and deploying

### Development

To develop the site do:

```

docker-compose up

```

in the project directory. This starts the webpack hot-reload dev server in

a docker container. There are also some dev-related scripts in

`package.json`:

```sh

npm run test               # run the tests

npm run lint               # run the linter

npm run singleTest ${path} # run a single test file

npm run watchTest ${path}  # run a single test file in watch mode

```

### Building

To build Markdown files from the Golang source code and build JSON from

all the Markdown do:

```

rake

```

This will write markdown files in `matasano` and will write JSON in

`src/data/`. For various pages the rendered (and highlighted) Markdown is

pulled out of those JSON files.

### Deploying

To deploy the website do:

```

npm run publish

```

This builds the JavaScript bundles for the site (`bundle.js`) and the

static routing script (`create_static_routes.js`). Then it runs the static

routing script, copies in the images, deploys to [another

repo](https://github.com/aliceriot/aliceriot.github.io) using

[gh-pages](https://github.com/tschaub/gh-pages), and then cleans out the

build directory.