Initial commit

.github/workflows/nodejs.yml

@@ -0,0 +1,34 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: "18.8"
+        cache: 'npm'
+    - run: npm ci
+    - run: CI=false npm run build --if-present
+
+    - name: Push
+      uses: s0/git-publish-subdir-action@develop
+      env:
+        REPO: self
+        BRANCH: build # The branch name where you want to push the assets
+        FOLDER: docs # The directory where your assets are generated
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub will automatically add this - you don't need to bother getting a token
+        MESSAGE: "Build: ({sha}) {msg}" # The commit message

.gitignore

@@ -0,0 +1,27 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+/docs
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# IDE
+.idea

README.md

@@ -0,0 +1,46 @@
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Corofides/Shimmer/nodejs.yml?logo=github&logoColor=white)
+[![pages-build-deployment](https://github.com/Corofides/Shimmer/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/Corofides/Shimmer/actions/workflows/pages/pages-build-deployment)
+
+[Shimmer Site](https://corofides.github.io/Shimmer)
+
+This is my attempt to create a site creator for use in a range of personal projects. It's written in 
+ReactJS and uses README and JSON files to create posts and pages. I'm hoping I can make it versatile
+enough that I can use it across a range of different projects. The main use case for this project is to
+power GitHub Page sites. I imagine it could be used in other settings too as under the hood it's just ReactJS.
+
+# Pages
+
+Pages are composed of different widgets, these exist on a grid based layout. Adding a new page to the site involves
+setting up a few attributes for the page and then providing it with an array of widgets. The widgets will then be
+displayed in the order provided. The widget object should include the name of the widget, the number of rows and columns
+the widget will span, and any arguments the widget requires. These will then be
+
+# Posts
+
+The site functions as a blogging platform and can display post objects in various areas across the site. To set up 
+posts this is done in two areas.
+
+## public/posts.json
+
+This file contains some basic information about each of the posts such as the title, author, and a README file name. The 
+basic information will be used and the README file will be utilised as the post content allowing you to easily author new
+posts for your site.
+
+## public/posts
+
+This folder contains a list of README files that will function as your post content. Most README settings will be
+capable of being displayed on the site. A README can be called anything you want so long as it is referenced in the
+posts.json file.
+
+
+# Settings
+
+This file contains some basic configuration settings for the site.
+
+## Site Name
+
+The name of the site - this will be used to display the name.
+
+## Site Author
+
+The person or company who owns the website.