forked from TBD54566975/developer.tbd.website
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* set up pnpm * fixed <Link /> related errors. Build still breaks bc of Context errors * added @docusuarus/types to fix pnpm duplicate projects * add examples * Add script for filterable tutorial * remove extra .git * Removed zero width space causing copy & paste issue * added Contributing Guide link to Open Source page. per isse 568 * adding clarifying info on send() functions * add dependency at root lvl and script command to update across all examples * clarified on send() * remove tbd dependencies from sub modules * update to 0.7.10 * attempt at env variables for making sure versions are consistent * blog post announcing chatgpt plugin for Web5 * meta img * Update 2023-01-04-manually-issue-vcs.md As-is, this link opens as https://json-schema.org/draft/2020-12/schema%22 @bobbilee19 * Update broken link to Credential Schema * Update Events Image * script and folder renames * Update site/blog/2023-01-04-manually-issue-vcs.md Use Gabe's updated link suggestion Co-authored-by: Gabe <[email protected]> * update scripts * explicitly show pnpm * guide on Agents * added glossary term. issue TBD54566975#560 * fixed broken link * Update sync.md * add What is Web5 link to docs page * incorporating Frank's review * update docs name to site and add clear script * update readme * added new API doc for protocol class. issue TBD54566975#559 * added new API doc for protocol class. issue TBD54566975#559. Co-authored-by:@bobbilee19 * Update protocol.mdx removed unnecessary comment * Issue TBD54566975#562 - Add Datadog analytics scripts * fixing code sample * move tutorial examples under tutorials folder * update lock file * remove npmrc * allocate files * update cloning instructions * added package.json for quickstart widget * testing monorepo deploy * update copy * updating css -paragraph color to white * made web5 widget runnable * update URLs * add netlify.toml at root level * set up pnpm * fixed <Link /> related errors. Build still breaks bc of Context errors * added @docusuarus/types to fix pnpm duplicate projects * add examples * Add script for filterable tutorial * remove extra .git * add dependency at root lvl and script command to update across all examples * remove tbd dependencies from sub modules * update to 0.7.10 * attempt at env variables for making sure versions are consistent * script and folder renames * update scripts * explicitly show pnpm * update docs name to site and add clear script * update readme * move tutorial examples under tutorials folder * update lock file * remove npmrc * allocate files * update cloning instructions * added package.json for quickstart widget * testing monorepo deploy * update copy * made web5 widget runnable * update URLs * add netlify.toml at root level * update url to point to index.js (will only work after merge) * fixed <Link /> related errors. Build still breaks bc of Context errors * add examples * remove tbd dependencies from sub modules * update to 0.7.10 * script and folder renames * update docs name to site and add clear script * move tutorial examples under tutorials folder * update lock file * remove npmrc * update url to point to index.js (will only work after merge) --------- Co-authored-by: Prod1gy0ne <[email protected]> Co-authored-by: Angie Jones <[email protected]> Co-authored-by: Andrew Lee Rubinger <[email protected]> Co-authored-by: Ebony Louis <[email protected]> Co-authored-by: Gabe <[email protected]>
- Loading branch information
1 parent
c24ed03
commit a326efa
Showing
61 changed files
with
34,583 additions
and
17,061 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# TBD Open Source Project Governance | ||
|
||
<!-- TOC --> | ||
|
||
- [Contributors](#contributors) | ||
- [Maintainers](#maintainers) | ||
- [Governance Committee](#governance-committee) | ||
|
||
<!-- /TOC --> | ||
|
||
## Contributors | ||
|
||
Anyone may be a contributor to TBD projects. Contribution may take the form of: | ||
|
||
- Asking and answering questions on the Discord or GitHub Issues | ||
- Filing an issue | ||
- Offering a feature or bug fix via a Pull Request | ||
- Suggesting documentation improvements | ||
- ...and more! | ||
|
||
Anyone with a GitHub account may use the project issue trackers and communications channels. We welcome newcomers, so don't hesitate to say hi! | ||
|
||
## Maintainers | ||
|
||
Maintainers have write access to GitHub repositories and act as project administrators. They approve and merge pull requests, cut releases, and guide collaboration with the community. They have: | ||
|
||
- Commit access to their project's repositories | ||
- Write access to continuous integration (CI) jobs | ||
|
||
Both maintainers and non-maintainers may propose changes to | ||
source code. The mechanism to propose such a change is a GitHub pull request. Maintainers review and merge (_land_) pull requests. | ||
|
||
If a maintainer opposes a proposed change, then the change cannot land. The exception is if the Governance Committee (GC) votes to approve the change despite the opposition. Usually, involving the GC is unnecessary. | ||
|
||
See: | ||
|
||
- [List of maintainers - `MAINTAINERS.md`](./MAINTAINERS.md) | ||
- [Contribution Guide - `CONTRIBUTING.md`](./CONTRIBUTING.md) | ||
|
||
### Maintainer activities | ||
|
||
- Helping users and novice contributors | ||
- Contributing code and documentation changes that improve the project | ||
- Reviewing and commenting on issues and pull requests | ||
- Participation in working groups | ||
- Merging pull requests | ||
|
||
## Governance Committee | ||
|
||
The TBD Open Source Governance Committee (GC) has final authority over this project, including: | ||
|
||
- Technical direction | ||
- Project governance and process (including this policy) | ||
- Contribution policy | ||
- GitHub repository hosting | ||
- Conduct guidelines | ||
- Maintaining the list of maintainers | ||
|
||
The current GC members are: | ||
|
||
- Ben Boeser, Technical Partnerships Lead, TBD | ||
- Angie Jones, Head of Developer Relations, TBD | ||
- Julie Kim, Head of Legal, TBD | ||
- Nidhi Nahar, Head of Patents and Open Source, Block | ||
- Andrew Lee Rubinger, Head of Open Source, TBD | ||
|
||
Members are not to be contacted individually. The GC may be reached through `[email protected]` and is an available resource in mediation or for sensitive cases beyond the scope of project maintainers. It operates as a "Self-appointing council or board" as defined by Red Hat: [Open Source Governance Models](https://www.redhat.com/en/blog/understanding-open-source-governance-models). |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# TBD Developer Site | ||
|
||
This is a monorepo powered by [pnpm](https://pnpm.io/) that includes a documentation site, tutorials and examples. This repository allows you to conveniently manage multiple projects within a single repository. | ||
|
||
## Prerequisites | ||
|
||
Before you begin, ensure that you have the following installed on your local machine: | ||
|
||
- [Node.js](https://nodejs.org/) (version 18.16.0 or later) | ||
- [pnpm](https://pnpm.io/) (version 7.29.1 or later) | ||
|
||
## Installation | ||
|
||
To install `pnpm` globally on your local machine, follow these steps: | ||
|
||
1. Open a terminal or command prompt. | ||
2. Run the following command: | ||
|
||
```shell | ||
npm install -g pnpm | ||
``` | ||
|
||
3. Wait for the installation process to complete. | ||
|
||
> Note: If you already have `pnpm` installed globally, you can skip this step. | ||
## Getting Started | ||
|
||
To get started with the monorepo and run the available scripts, follow these instructions: | ||
|
||
1. Clone the repository: | ||
|
||
```shell | ||
git clone https://github.com/TBD54566975/developer.tbd.website.git | ||
``` | ||
|
||
2. Navigate to the project directory: | ||
|
||
```shell | ||
cd developer.tbd.website | ||
``` | ||
|
||
3. Install project dependencies using `pnpm`: | ||
|
||
```shell | ||
pnpm install | ||
``` | ||
|
||
4. Once the installation is complete, you are ready to run the available scripts. | ||
|
||
## Scripts | ||
|
||
The following scripts are available for running specific tasks within the monorepo: | ||
|
||
- `pnpm start`: Runs the docs site. | ||
- `pnpm start:tutorial-todo-starter`: Starts the local server for the todo app tutorial. | ||
- `pnpm start:tutorial-todo-completed`: Starts the local server for the completed todo app. | ||
- `pnpm start:widget`: Runs the completed web5 widget | ||
- `pnpm clear`: Runs docusaurus clear | ||
|
||
## Running commands | ||
|
||
If for whatever reason, you'd like to run pnpm commands on specific packages only, use the `--filter` flag and refer to the package name of the project. | ||
|
||
Filter docs: https://pnpm.io/filtering | ||
|
||
For example, if you wanted to add a library to the docs site itself: | ||
|
||
`pnpm --filter docs add some-library` | ||
|
||
If you look at the package.json under the path: `/site/package.json`, you'll see the "name" attribute says "docs", which is what we're using to target. | ||
|
||
## Contributing | ||
|
||
If you wish to contribute to this project, please follow the guidelines outlined in the [CONTRIBUTING.md](CONTRIBUTING.md) file. | ||
|
||
## License | ||
|
||
This project is licensed under the [MIT License](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
module.exports = { | ||
parserOptions: { | ||
ecmaVersion: 2022 | ||
}, | ||
env: { | ||
node: true, | ||
}, | ||
extends: [ | ||
'eslint:recommended', | ||
'plugin:vue/vue3-strongly-recommended', | ||
], | ||
rules: { | ||
'key-spacing': [ | ||
'error', | ||
{ | ||
'align': { | ||
'afterColon' : true, | ||
'beforeColon' : true, | ||
'on' : 'colon' | ||
} | ||
} | ||
], | ||
'quotes': [ | ||
'error', | ||
'single', | ||
{ 'allowTemplateLiterals': true } | ||
], | ||
'semi' : ['error', 'always'], | ||
'vue/html-closing-bracket-newline' : ['error', { | ||
'multiline' : 'never', | ||
'singleline' : 'never' | ||
}], | ||
'vue/max-attributes-per-line': ['error', { | ||
'multiline': { | ||
'max': 4 | ||
}, | ||
'singleline': { | ||
'max': 4 | ||
}, | ||
}], | ||
'vue/static-class-names-order' : 'error', | ||
'indent' : ['error', 2] | ||
} | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
lerna-debug.log* | ||
|
||
node_modules | ||
dist | ||
dist-ssr | ||
*.local | ||
|
||
# Editor directories and files | ||
.vscode/* | ||
!.vscode/extensions.json | ||
.idea | ||
.DS_Store | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Todo List App <!-- omit from toc --> | ||
|
||
The main code that powers this app is [here](./src/App.vue) | ||
|
||
This Todo app uses the Web5 JS SDK (https://www.npmjs.com/package/@tbd54566975/web5) to create a DWN in your browser and add todos | ||
|
||
## Run and Build: | ||
Step 1: `npm install && npm run dev` | ||
|
||
Step 2: Navigate to `http://localhost:5173` <br /> | ||
|
||
All todos are being stored in your DWN |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<!DOCTYPE html> | ||
<html lang="en" class="h-full"> | ||
|
||
<head> | ||
<meta charset="UTF-8" /> | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
</head> | ||
|
||
<body class="h-full"> | ||
<div id="app"></div> | ||
<script type="module" src="/src/main.js"></script> | ||
</body> | ||
|
||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
[build] | ||
command = "pnpm build" | ||
publish = "dist" | ||
|
||
[build.environment] | ||
NPM_FLAGS = "-store-dir .pnpm-store" | ||
|
Oops, something went wrong.