aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFurkan Sahin <furkan-dev@proton.me>2021-07-21 05:03:47 -0500
committerFurkan Sahin <furkan-dev@proton.me>2021-07-21 05:03:47 -0500
commit0fc0a3165ef1eba60aeb7aa3ce4cd8b322888d03 (patch)
tree7092bcbc69ad58169b32918a16b7bbc4e062e519 /README.md
parentf42a9a3052086a6369d6a5566c613fccc4d3c6d6 (diff)
Added README
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ce2d3b3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+Homepage
+========
+
+This is the source for my [personal webiste](https://www.furkistan.com). It's effectively a static site.
+
+It's written using the `next.js` framework which a SSO rendering system built on `react` and `typescript`. `nginx` reverse proxies and caches it. `next.js` overkill for a small, static project. But, the code is lean and clean. If I want to do something fancy in the future, I have all the tools.
+
+I did all the theming: simple, readable, clean, and monospaced. I also wrote a trivial CMS based on markdown and JSON for metadata.
+
+```
+├── components REUSABLE COMPONENTS
+├── pages TOP LEVEL COMPONENTS
+├── plugins WEBPACK PLUGINS
+├── posts CMS DIRECTORY WITH POSTS "LOGS"
+├── public STATIC DATA
+├── styles PRELOADED STYLE
+├── templates PAGE TEMPLATES
+└── utils UTILS (MOSTLY LOADING HELPERS)
+``` \ No newline at end of file