pomp/pompy.dev
1
0
Fork 0
Code Issues 8 Pull requests Activity Actions
A collection of "pomp-branded" websites https://pompy.dev
17 commits 1 branch 0 tags 25 MiB
Find a file
developomp 8a2db03c0f - added custom spinner to use instead of imported ones 
- added new empty blog post
- changed react-helmet to react-helmet-async for faster tab title change and reduced console warning
- better eslint config and corresponding warning fixes (changing let -> const, removed unused variables, etc.)
- removed redundant Router from footer
- removed ignored preload attribute value from font loading link tag in index.html
2021-05-15 19:50:00 +09:00
.vscode added public folder, vscode settings, and updated README 2021-05-15 12:44:46 +09:00
source - added custom spinner to use instead of imported ones 2021-05-15 19:50:00 +09:00
.gitignore added public folder, vscode settings, and updated README 2021-05-15 12:44:46 +09:00
.prettierrc moving from hexo theme to my own react design 2021-05-15 00:30:19 +09:00
CONTRIBUTING.md moving from hexo theme to my own react design 2021-05-15 00:30:19 +09:00
downloading.png moving from hexo theme to my own react design 2021-05-15 00:30:19 +09:00
firebase.json initial commit 2021-02-13 16:02:10 +09:00
LICENSE initial commit 2021-02-13 16:02:10 +09:00
LICENSE_OFL moving from hexo theme to my own react design 2021-05-15 00:30:19 +09:00
README.md added public folder, vscode settings, and updated README 2021-05-15 12:44:46 +09:00

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 HTML head management
dompurify HTML sanitizer for markdown-to-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-to-html generator
jest code testing
react-spinners loading indicator

Setup

Requirement:

*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

License

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

Font license:

Open Font License (OFL) (Source):