TBD Developer Site

🎉 We're participating in Hacktoberfest 2023! 🎉

Want to contribute during Hacktoberfest? We'd love to have you! Dive in, and your contributions could earn you some exclusive rewards.

The first 20 contributors to successfully merge a PR will secure exclusive swag of their choosing from our TBD shop. Keep an eye on our leaderboard issue to see where you rank! ⭐️

🚀 Gear up for a month packed with exciting events! 🎉

Mark your calendars for our Hacktoberfest Launch event on October 2nd.
Stay in the loop - keep an eye on our Discord calendar and pop into our events-and-updates channel regularly! You won't want to miss out!

Hacktoberfest Guidelines:

Ensure your contribution is meaningful and fits within the scope of our project, by reading an open issue in its entirety before diving in.
Check out our good-first-issue, no-code and hacktoberfest labels in the issues section.
Join our Discord: Connect with the community, stay up to date with Hacktoberfest events/prizes, and discuss Hacktoberfest contributions on our Discord server. Click here to join.
Always be respectful and follow our code of conduct.
If in doubt about what to contribute, reach out to maintainers by raising a question in the relevant issue or specified discord channel.
Other participating TBD Repos:

What is Hacktoberfest?

Celebrate the 10th anniversary of Hacktoberfest this year! Hosted annually every October, Hacktoberfest is a month-long event sponsored by DigitalOcean, GitHub, and various other partners, championing open-source contributions.

⭐️ If you're new to Hacktoberfest, you can learn more and register to participate here. Registration is from September 26th- October 31st.

New Contributor? Welcome! 🌟

We wholeheartedly embrace new contributors to our community. Remember, every expert was once a beginner, and we understand the initial hurdles you might feel. Here’s how you can dive in:

Join Our Discord Channel:
- Once inside, check out the Hacktoberfest section. This has all you need: resources, guidelines, and a checklist to help you make your first hacktoberfest contribution.
Feeling Anxious or Unsure? Find a Buddy!:
- Head over to our hack-together section on Discord. It's perfectly normal to feel a tad overwhelmed or even the impostor syndrome on your first go. In this space, you can partner with someone to collaborate, share thoughts, or jointly tackle an issue. You know what they say, two heads are better than one!
Dive In:
- Skim through our open issues and pick one you vibe with. And if you're on the fence about anything, don't hesitate to ask. Your new community is here to assist and walk with you every step of the way.
- Mark your calendars for our Hacktoberfest Launch event on October 2nd.
- Stay in the loop - keep an eye on our Discord calendar and pop into our #events-and-updates channel regularly! You won't want to miss out!

Your contribution, be it big or minuscule, carries immense value. We eagerly await to see the waves you'll make in our community! 🚀

Here's to a thrilling Hacktoberfest voyage with us! 🎉

Prerequisites

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:

Node.js (version 18.16.0 or later)
pnpm (version 7.29.1 or later)

Running online environment

Interested in contributing instantly? You can make your updates directly without cloning in the running CodeSandbox environment.

Installation

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 pnpm installed globally, you can skip this step.

Getting Started

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.

Scripts

The following scripts are available for running specific tasks within the monorepo:

pnpm start: Runs the docs site for auto-refresh in development mode
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
pnpm build: Runs the production build for the site so it can be hosted by a static web server. The completed build will be in the folder site/build.

Extra Features

We have implemented extra features in the website that don't come turned on by default, as an example we have the Feedback Widget feature, which allows an user to upvote or downvote a docs page.

These features are enabled from environment variables set in the file .env, inside the site folder. To enable them, copy the example .env file:

cp site/.env.example site/.env

And modify the parameters accordingly to the feature you want to play with! Check their instructions below:

FEEDBACK_WIDGET_API_URL: enables feedback widget api url; Feedback server app instructions
DOC_SEARCH_*: enables the search bar powered by Algolia; Algolia connecting instructions

Remember, when these environment variables are not set these features are disabled by default.

Note

This repo made a switch from using npm to pnpm as the package manager in July 2023. If you have used prior versions of this repo built on your machine with npm, you may encounter build failures, like:

[ERROR] Unable to build website for locale en.
[ERROR] Error: Cannot mix different versions of joi schemas
    at new module.exports (/Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/@hapi/hoek/lib/error.js:23:19)
    at module.exports (/Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/@hapi/hoek/lib/assert.js:21:11)
    at exports.isSchema (/Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/joi/lib/common.js:132:5)
    at internals.schema (/Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/joi/lib/compile.js:66:16)
    at exports.schema (/Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/joi/lib/compile.js:17:26)
    at internals.Base.$_compile (/Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/joi/lib/base.js:646:24)
    at /Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/joi/lib/types/keys.js:262:92
    at exports.tryWithPath (/Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/joi/lib/common.js:176:16)
    at internals.Base.method [as keys] (/Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/joi/lib/types/keys.js:262:32)
    at internals.Base.method [as append] (/Users/alr/git/TBD54566975/developer.tbd.website/site/node_modules/joi/lib/types/keys.js:191:29)

To fix this, clear out all instances of node_modules in this monorepo, then run pnpm install. This can be done like:

$> npx npkill
[Follow prompts to delete all node_modules folders]
[CNTL-C to exit]
$> pnpm install

This will update your dependences to the mechanism used by pnpm.

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 file.

License

This project is licensed under the MIT License.

mishmanners / developer.tbd.website