Merge pull request #59 from agile-ts/develop

Develop

Author: bennobuilder

.eslintignore

@@ -4,4 +4,8 @@ node_modules
 jest.config.js
 jest.config.base.js
 scripts/
-examples/
+examples/
+build
+.docusaurus
+docusaurus.config.js
+typings

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: 🐛 Bug report about: Create a report to help us improve AgileTs title: ''
+labels: 'Type: Bug' assignees: ''
+
+---
+
+## 🐛 Bug report
+
+### 🤖 Current Behavior
+
+<!-- Explain your problem (with screenshots, videos, text) in detail -->
+
+### 🎯 Expected behavior
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+### 💡 Suggested solution(s)
+
+<!-- How could we solve this bug? What changes would need to made to AgileTs? -->
+
+### ➕ Additional notes
+
+<!-- Add any other context about the problem here.  -->
+
+### 💻 Your environment
+
+<!-- PLEASE FILL THIS OUT -->
+
+| Software              | Name       | Version    |
+| ----------------------| ---------- | ---------- |
+| Browser (Chrome, ..)  |            |            |
+| System(macOS, ..)     |            |            |
+
+<!-- Any additional important Version Notes? -->

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,8 @@
+---
+name: 🔨 Custom issue template about: Describe this issue template's purpose here. title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: 🆕 Feature request about: Suggest an idea for this project title: ''
+labels: 'Type: Enhancement' assignees: ''
+
+---
+
+## 🆕 Feature Request
+
+### ❓ Is your feature request related to a problem?
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+### 📄 Describe the solution you'd like
+
+<!-- A clear and concise description of what you want to happen. -->
+
+### 📃 Describe alternatives you've considered
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+### ➕ Additional Notes
+
+<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+<!--- Please provide a general summary of your changes in the title above -->
+
+## 📄 Description
+
+<!--- Please describe all your changes in detail -->
+
+## 🔴 Related Issue
+
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please provide a link to the issue here -->
+
+## 📃 Context
+
+<!--- Why is this change required/wanted? What problem does it solve? -->
+<!--- If this fixes an open issue, please provide a link to the issue here. -->
+
+## 🛠 How Has This Been Tested?
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include information about your testing environment, and the tests you ran to -->
+<!--- see how your change might have affects other areas of the code, etc. -->

.github/static/landing.png

@@ -0,0 +1,37 @@
+name: Test Website
+on:
+  pull_request:
+    branches: [ "*" ]
+    types: [ "opened", "reopened" ]
+
+jobs:
+  publish:
+    name: Test Website
+    runs-on: ubuntu-latest
+    steps:
+
+      # Checkout Project
+      - name: 📚 Checkout
+        uses: actions/checkout@v2
+
+        # Setup NodeJS
+      - name: 🟢 Setup Node ${{ matrix.node_version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+
+        # Install Dependencies
+      - name: ⏳ Install
+        run: yarn install
+
+        # Run Tests
+      - name: 🤔 Test
+        run: yarn test
+
+        # Run Linter
+      - name: 🤖 Lint
+        run: yarn run lint
+
+        # Build Packages for Testing
+      - name: 🔨 Build Packages
+        run: yarn run build

.github/workflows/test-website.yaml

@@ -3,6 +3,7 @@
 dist
 yalc.lock
 /.yalc
+.eslintcache
 
 # Production
 /build

.gitignore

@@ -1,6 +1,17 @@
-# Website
-
-This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+# agile-ts.org
+
+<div align="center">
+  <a href="https://agile-ts.org">
+    <img src=".github/static/landing.png"/>
+  </a>
+</div>
+
+[This website](https://agile-ts.org) is built using
+[Docusaurus 2](https://v2.docusaurus.io/). Pages & components are written in TypeScript, the styles in vanilla CSS with
+variables using
+[CSS Modules](https://github.com/css-modules/css-modules).
+(We would have preferred using [styled-components](https://styled-components.com/) but docusaurus has no ssr support for
+it yet)
 
 ## Installation
 

README.md

@@ -6,10 +6,11 @@
     "docusaurus": "docusaurus",
     "start": "docusaurus start",
     "build": "docusaurus build",
+    "build:serve": "yarn run build && yarn run serve",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "serve": "docusaurus serve",
-    "buildserve": "yarn run build && yarn run serve",
+    "test": "jest --passWithNoTests",
     "install-docusaurus": "yalc add @docusaurus/core & yarn install",
     "prettier": "prettier --config .prettierrc --write \"**/*.{js,ts}\"",
     "lint": "eslint --cache \"**/*.{js,jsx,ts,tsx}\"",
@@ -43,11 +44,15 @@
     "@types/react-helmet": "^6.1.0",
     "@types/react-router-dom": "^5.1.6",
     "@types/styled-components": "^5.1.0",
+    "@types/jest": "^26.0.15",
+    "@typescript-eslint/eslint-plugin": "^4.12.0",
+    "@typescript-eslint/parser": "^4.12.0",
     "eslint": "^7.17.0",
     "eslint-config-node": "^4.1.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.3.1",
+    "jest": "^26.6.3",
     "prettier": "2.1.2",
     "ts-node": "^8.10.2",
     "typescript": "^4.1.5"