pompy.dev/README.md

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-async	HTML head management
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 formatting
ts-node	running markdown-to-html generator
jest	code testing

Setup

Requirement:

• node
• yarn (npm is not supported)
• optional:
  • git
  • vscode
    • extensions (also optional but highly recommended):

Steps:

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

Contributing

Please read the CONTRIBUTING.md file.

Special thanks

• Ruipeng Zhang for design inspiration (hexo-icarus-theme)
• discord for dark theme color palette (before the rebranding of May 2021)
• My friend Aditya Prakash for extensive testing and wonderful suggestions

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)