Skip to content

README.md

Latest commit

 

History

History
97 lines (66 loc) · 3.33 KB

README.md

File metadata and controls

97 lines (66 loc) · 3.33 KB
Eden's avatar

EdenCrow.info

NodeJS npm Hugo GitHub Pages

License: MIT License: CC BY 4.0

The repository for my personal homepage.

image

Table of Contents
  1. About
  2. Development
  3. Roadmap
  4. Licenses
  5. Acknowledgements

🤨 About

This repository contains the source code for my personal website EdenCrow.info.

The site is created with the use of:

  • NodeJS: Javascript runtime environment
  • npm: package management
  • Hugo (via hugo-bin): static site generation
  • hugo-coder: site theme
  • Webpack: module bundling
  • and a small selection of other npm packages

It is automatically deployed to GitHub Pages via GitHub Actions.

Each section (eg. the homepage) is being developed one at a time, and will be pushed live once complete.

🔧 Development

Prerequisites

Download

  1. Clone this repository
  2. Run npm install to install dependencies

Serving locally

  1. Run npm run serve
  2. The site will be accessible at http://localhost:1313/ and saved changes will automatically rebuild
  3. Terminate the process when finished
  4. Run npm run clean to clean folder structure

🎯 Roadmap

To see the roadmap for this project, please check the relevant wiki page.

📜 Licenses

Original code for this project is licensed under the MIT license.

Blog content posted to the site is licensed under CC BY 4.0.

⭐ Acknowledgements

README support