Skip to content

Commit 58fb978

Browse files
authored
Merge branch 'main' into gitpod
2 parents 78552d6 + 776f9c0 commit 58fb978

38 files changed

+24014
-1
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Simple workflow for deploying static content to GitHub Pages
2+
name: Deploy static content to Pages
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches: [main]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow one concurrent deployment
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: true
22+
23+
jobs:
24+
# Single deploy job since we're just deploying
25+
deploy:
26+
environment:
27+
name: github-pages
28+
url: ${{ steps.deployment.outputs.page_url }}
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v3
33+
- name: Setup NodeJS
34+
uses: actions/setup-node@v3
35+
with:
36+
node-version: 16.x
37+
cache: npm
38+
- name: Install Dependencies
39+
run: cd docs && npm install
40+
- name: Build
41+
run: cd docs && npm run build
42+
- name: Setup Pages
43+
uses: actions/configure-pages@v2
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v1
46+
with:
47+
# Upload entire repository
48+
path: 'docs/build'
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v1

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributions
2+
3+
## Contributing to Workflow
4+
5+
A big welcome and thank you for considering contributing to the **workflow** open source project monorepo! It’s people like you that make it a reality for users in our community.
6+
7+
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this open source project. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
8+
9+
## Quicklinks
10+
11+
- [Contributions](#contributions)
12+
- [Contributing to Workflow](#contributing-to-workflow)
13+
- [Quicklinks](#quicklinks)
14+
- [Getting Started](#getting-started)
15+
- [Code of Conduct](#code-of-conduct)
16+
- [Issues](#issues)
17+
- [Pull Requests](#pull-requests)
18+
- [Getting Help](#getting-help)
19+
20+
## Getting Started
21+
22+
## Code of Conduct
23+
24+
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](/community/code-of-conduct).
25+
26+
<hr>
27+
28+
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
29+
30+
- Search for existing Issues and PRs before creating your own.
31+
- We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
32+
- If you've never contributed before, check out [this awesome blog](https://auth0.com/blog/a-first-timers-guide-to-an-open-source-project/) for resources and tips on how to get started.
33+
34+
### Issues
35+
36+
Issues should be used to report problems with the project, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
37+
38+
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.
39+
40+
### Pull Requests
41+
42+
PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
43+
44+
- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
45+
- Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
46+
- Address a single concern in the least number of changed lines as possible.
47+
- Include documentation in the repo or on our [docs site](/).
48+
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
49+
50+
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
51+
52+
In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
53+
54+
1. Fork the repository to your own Github account
55+
2. Clone the project to your machine
56+
3. Create a branch locally with a succinct but descriptive name
57+
4. Commit changes to the branch
58+
5. Following any formatting and testing guidelines specific to this repo
59+
6. Push changes to your fork
60+
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
61+
62+
## Getting Help
63+
64+
You can always reach out to the community or one of the maintainers for help. Feel free to triage issues. Every bit of information helps !

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ npm -v
6464
## Hasura Submissions
6565
- Covering how to handle form data submission to your database be it a sql or NoSql based db. In our setup we have used Hasura which creates an instant GraphQL data provider to use with Postgres based db
6666

67+
6768
![Hasura Submissions](https://user-images.githubusercontent.com/46066481/227329443-0c832935-ac4c-42ea-80e6-ee00282aa6e6.gif)
6869

6970
## Offline Capabilites

docs/.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

docs/.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v16.17.1

docs/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Advanced Guides",
3+
"position": 4,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Learn more and div deeper into the details of the Architecture we have implemented."
7+
}
8+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "Architecture",
3+
"position": 3,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Learn more and div deeper into the details of the Architecture we have implemented."
7+
}
8+
}
9+
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Hello World

0 commit comments

Comments
 (0)