developomp-site

Repository for my (developomp's) website.

Tools/Frameworks/Packages used:

Name	Use
AWS	Domain register
Firebase	Static site hosting
Typescript	Static typing for javascript
react	Front end framework
react-fontawesome	Fontawesome icons in react
react-helmet	HTML head management
dompurify	HTML sanitizer for markdown -> HTML page generation
gray-matter	parsing markdown
local-storage-fallback	storing theme choice
react-tooltip	Tooltips
styled-components	easier CSS styling
styled-theming	Theming
eslint	code analysis
prettier	code formatter
ts-node	running markdown->html generator
jest	code testing
react-spinners	loading indicator

Setup

Requirement:

• node
• yarn or npm*
• optional:
  • git
  • vscode
    • extensions (also optional but recommended):
      • styled components
      • prettier
      • react
      • eslint

*Usage of yarn is highly recommended over npm

Steps:

• Clone this repository
  • git clone https://github.com/developomp/developomp-site.git
• Or download compressed as zip
  • 
• open source directory
  • cd source
• Install dependencies (must be in source directory)
  • yarn install
• start local server in http://localhost:3000
  • yarn start

How it works

single page application react to build front end components sunning yarn generate converts markdown to html and in json with parsed meta by date, etc. Does not scale well but I won't have 10k posts any time soon few thousand so more than good enough

generator underscore no symbolic links filename encoder not perfect. Some filenames might cause problem.

Contributing

Please read the CONTRIBUTING.md file.

Special thanks

• design inspirations from Ruipeng Zhang's icarus theme for hexo.
• dark theme color from discord

License

This project is licensed under the MIT License.
Check the LICENSE file for more information.

Font license:

Open Font License (OFL) (Source):

• Source Code Pro (monospaced code font)
• Noto Sans KR (Korean and English font)