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
react	Front end framework
react-tooltip	Tooltips
react-date-range	Date picker for search page
elasticlunr	Search engine
gray-matter	Markdown parsing
markdown-it	Markdown rendering

Setup

Requirements:

• node
• yarn
• optional:
  • 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.

How it works

Check the generator.ts source code for more detailed information.

The command yarn start does two things under the hood:

1. it executes the generate.ts script that converts markdown files to json files so it can be imported by react during runtime. To perform the conversion without serving the app, run yarn generate command in the source directory.

2. it serves the app in http://localhost:3000 as normal just like any other react apps.

Special thanks

• Ruipeng Zhang for design inspiration (hexo-icarus-theme)
• Artem Golubin for design inspiration (his blog)
• discord for dark theme color palette (before the rebranding of May 2021)
• My dear 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 Code Pro (monospaced code font)
• Noto Sans KR (Korean and English font)