Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/awayken/miles.ink

The writing homepage for Miles Rausch.
https://github.com/awayken/miles.ink

css eleventy homepage html showcase writing

Last synced: 10 days ago
JSON representation

The writing homepage for Miles Rausch.

Awesome Lists containing this project

README

        

# miles.ink

> The writing homepage for Miles Rausch.

[![Build Status](https://travis-ci.org/awayken/miles.ink.svg?branch=master)](https://travis-ci.org/awayken/miles.ink)

[Miles.ink](https://miles.ink) is the homepage to learn more about Miles Rausch as a writer. It's powered by [Eleventy](https://www.11ty.dev/) and written by me, Miles Rausch.

**WHAT??** Yes, the writer, Miles Rausch, is also [the developer, Miles Rausch](https://github.com/awayken/).

What's Miles.ink made out of?

* [git](http://git-scm.com/)
* [GitHub](https://github.com/)
* [Eleventy](https://www.11ty.dev/)
* [Travis CI](https://travis-ci.org/)

## Generating Miles.ink

Miles.ink is built on Eleventy. To see the site, we have to generate it. Eleventy builds static sites from all sorts of magic parts. There's data, posts, layouts and CSS to do styling.

To generate the site:

npm run build

## Serving Miles.ink

Eleventy has a built-in server that can watch your files for updates and refresh the page for you. Cool? Def.

To serve the site:

npm start

## Deploying Miles.ink

Miles.ink uses a Node script to deploy itself. To take advantage of `deploy.js`, you need to define some environment variables. The project includes the `dotenv` npm package to help facilitate this process. Make a copy of `sample.env`, rename it to `.env` and then fill out the values appropriately for your target FTP server. DO NOT commit your new `.env` file. It is ignored for a reason: to keep your secrets safe.

To deploy the site:

npm run deploy