pompy.dev/README.md

developomp-site

Source code for my (developomp's) website.

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 comments generator.ts file for more detailed information.

When you run the yarn start command, the project executes the generate.ts script before starting the app. This script converts markdown files to json files so it can be imported by react on the frontend.

To perform the conversion without starting the app, run yarn generate command.

To start the app without generating json files, run yarn quick-start command.

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)