Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Scaffolder committed Oct 1, 2024
0 parents commit cdef32c
Show file tree
Hide file tree
Showing 15 changed files with 4,625 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Test

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
build_and_test:
runs-on: ubuntu-latest

env:
CI: true
NODE_ENV: test

steps:
- name: Log node version
run: node --version

- uses: actions/checkout@v2
with:
fetch-depth: '0'

- name: Install dependencies
run: yarn install --frozen-lockfile

- name: Cypress run
uses: cypress-io/github-action@v2
with:
start: yarn start --port 8001

- name: Upload screenshots
uses: actions/upload-artifact@v1
if: failure()
with:
name: cypress-screenshots
path: cypress/screenshots

- name: Upload videos
uses: actions/upload-artifact@v1
if: always()
with:
name: cypress-videos
path: cypress/videos

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
dist
.parcel-cache
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Lskdhflshflkl

This is a website wihch is published on GitHub pages.

## Getting started

```bash
yarn install
yarn start
```

Now open up: http://localhost:1234 in your browser.

## Testing

End to end tests can be written with Cypress.io.

They are run locally like this:

```bash
yarn test
```

## Docs

Docs can be found in the `docs` directory. They are written in markdown.
15 changes: 15 additions & 0 deletions catalog-info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: sfsfsfsdfsdf
title: Lskdhflshflkl
description: A static HTML website. Just like the good old days.
links:
- url: https://roadiehq.github.io/sfsfsfsdfsdf/
title: Live website
annotations:
github.com/project-slug: roadiehq/sfsfsfsdfsdf
spec:
type: website
owner: user:dtuite
lifecycle: experimental
3 changes: 3 additions & 0 deletions cypress.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"baseUrl": "http://localhost:8001"
}
6 changes: 6 additions & 0 deletions cypress/integration/sample_spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
describe('The website', () => {
it('is accessible', () => {
cy.visit('');
cy.contains('Welcome to lskdhflshflkl').click();
})
})
22 changes: 22 additions & 0 deletions cypress/plugins/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/// <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}
*/
// eslint-disable-next-line no-unused-vars
module.exports = (on, config) => {
// `on` is used to hook into various events Cypress emits
// `config` is the resolved Cypress config
}
25 changes: 25 additions & 0 deletions cypress/support/commands.js
Original file line number Diff line number Diff line change
@@ -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) => { ... })
20 changes: 20 additions & 0 deletions cypress/support/index.js
Original file line number Diff line number Diff line change
@@ -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')
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
These are the docs for the Lskdhflshflkl website.

This is where you would put information about getting started with the website, maybe how
to authenticate etc.


It's just normal markdown. For example, you can write code blocks here like this:

```js

const myFunction = () => {
return 'Hello World';
};
```

When you add a new docs file, be sure to update the `mkdocs.yml` file in this repo to
display the file in the sidebar.
12 changes: 12 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Lskdhflshflkl</title>
</head>
<body>
<h1>Welcome to lskdhflshflkl</h1>
<p>This website was created by following the <a href="https://roadie.io">Backstage scaffolder tutorial published by Roadie<a></p>
</body>
</html>
8 changes: 8 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
site_name: Lskdhflshflkl

nav:
- Home: index.md

plugins:
- monorepo
- techdocs-core
19 changes: 19 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "sfsfsfsdfsdf",
"version": "0.0.1",
"description": "A static HTML website. Just like the good old days.",
"main": "index.js",
"repository": "https://github.com/roadiehq/sfsfsfsdfsdf",
"author": "roadiehq",
"license": "MIT",
"private": true,
"devDependencies": {
"cypress": "^9.4.1",
"parcel": "^2.2.1"
},
"scripts": {
"start": "parcel index.html",
"test": "cypress open"
}
}

18 changes: 18 additions & 0 deletions package.json.tpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "github-pages-site-skeleton",
"version": "0.0.1",
"description": "A skeleton for creating a GitHub pages site.",
"main": "index.js",
"repository": "https://github.com/roadiehq/software-templates",
"author": "David Tuite",
"license": "MIT",
"private": true,
"devDependencies": {
"cypress": "^9.4.1",
"parcel": "^2.2.1"
},
"scripts": {
"start": "parcel index.html",
"test": "cypress open"
}
}
Loading

0 comments on commit cdef32c

Please sign in to comment.