Hello, my name is Sera (@cellsera_c on Discord), and I am the Team Leader for the Web Dev Team!
Before continuing with this doc, please read the General Onboarding Document.
What We Do
Section titled “What We Do”The Web Dev team is responsible for implementing and maintaining the various websites that the project hosts.
Currently, the project has 2 repositories:
P3D Web is designed to act as the primary gateway for the project, serving as the main distribution point for project updates.
It is built on the Astro framework with React components and Tailwind CSS to leverage fast static-site generation and responsive, utility-driven design.
P3D Docs is the official documentation website. It serves as the main distribution point for all project docs, including team setup & codebase references.
Engineered for high performance and long-term maintainability, it is built on the Astro framework with React components and Tailwind CSS to leverage fast static-site generation and responsive, utility-driven design.
Elizabeth Bot is a bespoke Discord onboarding and application management bot built for the P3D Project that streamlines the applicant workflow.
Contributions
Section titled “Contributions”Before contributing, please read our Git Guidelines. Any contributions that do not follow these guidelines will NOT be accepted!
The process of assigning tasks is self-directed. You'll need to select a task from the GitHub Project Board under “Ready” & assign yourself & assign yourself. Sometimes, team leads will ask you to do some issues as well.
Once you have finished, please share photos/videos/PR of the completed issue to the #web-lounge for feedback. Once we've given the OK, you can upload the files to the Web team’s folder in Google Drive (if relevant).
Make sure that you strictly follow the Roadmap. If you want to work on an issue that isn’t on the roadmap, make sure you get approval from the team lead (cellsera_c) or the project lead (thebosst). If you want to work on an issue that IS on the Roadmap, find the associated GitHub issue! If you can’t find it, feel free to make a new issue under the “New” tab.
All new Web team members must also read Web Dev Team Reference & Art Standards
AI Usage Policy
Section titled “AI Usage Policy”The usage of AI tools is permitted if used responsibly, to be more precise under these conditions:
- You designed the core idea. AI can help you implement or refine it, not invent it for you.
- You understand it. If you can't explain what the code does, it doesn't belong in a PR.
- No slop. Generated code must be clean, logical, and intentional.
Tools & Setup
Section titled “Tools & Setup”The team uses VS Code as the development IDE, & Node.js as the JavaScript runtime environment.
The setup for all Web Dev repos are the same. Just ensure that you pull the correct repo!
Prerequisites
Section titled “Prerequisites”You need to have VS Code, Node.js, & pnpm already installed on your system.
1. Clone the Repo
Section titled “1. Clone the Repo”p3d-web
Section titled “p3d-web”git clone https://github.com/p3d-project/p3d-web.gitcd p3d-webp3d-docs
Section titled “p3d-docs”git clone https://github.com/p3d-project/p3d-docs.gitcd p3d-docs2 Install Dependencies
Section titled “2 Install Dependencies”pnpm install3. Run the site
Section titled “3. Run the site”Build for development
Section titled “Build for development”pnpm run devYou should keep an eye out on the terminal for your dev url. By default, it should be http://localhost:4321 by default.
Build for production
Section titled “Build for production”pnpm run buildYou are now ready to code!
Quick Links
Section titled “Quick Links”Repositories
Section titled “Repositories”All docs can be found on this docs.p3dual.com, which pulls files from p3d-docs and the shared P3D Project - Team Google Drive
Questions
Section titled “Questions”If there are any questions, ping Web Dev lead @cellsera_c on Discord in the #team-general or #web-dev-lounge channel depending on the question.