This is a monorepo powered by pnpm that includes a documentation site, tutorials and examples. This repository allows you to conveniently manage multiple projects within a single repository.
Before you begin, ensure that you have the following installed on your local machine:
To install pnpm globally on your local machine, follow these steps:
- Open a terminal or command prompt.
- Run the following command:
npm install -g pnpm- Wait for the installation process to complete.
Note: If you already have
pnpminstalled globally, you can skip this step.
To get started with the monorepo and run the available scripts, follow these instructions:
- Clone the repository:
git clone https://github.com/TBD54566975/developer.tbd.website.git- Navigate to the project directory:
cd developer.tbd.website- Install project dependencies using
pnpm:
pnpm install- Once the installation is complete, you are ready to run the available 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 widgetpnpm clear: Runs docusaurus clear
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.
If you wish to contribute to this project, please follow the guidelines outlined in the CONTRIBUTING.md file.
This project is licensed under the MIT License.