test: add example app

Author: wojtek-krysiak

.gitignore

@@ -157,4 +157,7 @@ dist
 # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
 
 types
-build
+build
+.adminbro
+
+example-app/cypress/videos

.npmignore

@@ -1,3 +1,4 @@
 node_modules
 .github
 coommitlint.config.js
+example-app

example-app/cypress.json

@@ -0,0 +1,3 @@
+{
+  "baseUrl": "http://localhost:3000/admin"
+}

example-app/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

example-app/cypress/integration/example.spec.ts

@@ -0,0 +1,9 @@
+context('Dashboard Page', () => {
+  beforeEach(() => {
+    cy.visit('/')
+  })
+
+  it('shows overridden sidebar footer', () => {
+    cy.contains('Welcome on Board')
+  })
+})

example-app/cypress/plugins/index.js

@@ -0,0 +1,21 @@
+/// <reference types="cypress" />
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+}

example-app/cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add("login", (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

example-app/cypress/support/index.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

example-app/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "example-app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "scripts": {
+    "start": "ts-node src/index.ts",
+    "cypress:open": "cypress open",
+    "cypress:run": "cypress run"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.7",
+    "ts-node": "^8.10.2",
+    "cypress": "^4.11.0",
+    "typescript": "^3.9.7"
+  },
+  "dependencies": {
+    "@admin-bro/core": "^3.0.0-beta.2",
+    "@admin-bro/express": "^3.0.0-beta.1",
+    "express": "^4.17.1",
+    "express-formidable": "^1.2.0",
+    "express-session": "^1.17.1"
+  }
+}

example-app/src/index.ts

@@ -0,0 +1,20 @@
+import express from 'express'
+import AdminBro from '@admin-bro/core'
+import { buildRouter } from '@admin-bro/express'
+
+const PORT = 3000
+
+const run = async () => {
+  const app = express()
+  const admin = new AdminBro()
+  const router = buildRouter(admin)
+
+  app.use(admin.options.rootPath, router)
+
+  app.listen(PORT, () => {
+    // eslint-disable-next-line no-console
+    console.log(`Example app listening at http://localhost:${PORT}`)
+  })
+}
+
+run()

example-app/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+      "outDir": "./build",
+      "target": "es2017",
+      "esModuleInterop": true,
+      "jsx": "react",
+      "strictNullChecks": true,
+      "strictPropertyInitialization": true,
+      "strictFunctionTypes": true,
+      "strictBindCallApply": true,
+      "noImplicitThis": true,
+      "moduleResolution": "node",
+      "module": "commonjs",
+      "types": ["cypress"]
+  },
+  "include": [
+      "./src/**/*",
+      "./cypress/**/*"
+  ],
+}