Have questions or need guidance? Our contributors are happy to help! Join the conversation and get your doubts resolved:
To get started with contributing to recode hive, please refer to our Contributing Guidelines.
flowchart LR
Fork[Fork the project]-->branch[Create a New Branch]
branch-->Edit[Edit file]
Edit-->commit[Commit the changes]
commit -->|Finally|creatpr((Create a Pull Request))
-
Clone the repository:
git clone https://github.com/your-username/recodehive-website.git
-
Navigate to the project directory:
cd recode-website
-
Prerequisites
- Docker installed
- Docker compose installed (Optional)
-
Build the Docker Image: Only do this if you are setting up this project locally for the first time. (only build)
docker build -t recodehive-app .
-
Run the Container:
docker run -p 3000:3000 recodehive-app
This command will start a development server and open the application in your default web browser.
For an even smoother experience, contributors can leverage Docker Compose with hot-reloading.
This lets you see code changes instantly at http://localhost:3000 without rebuilding or restarting containers.
git clone https://github.com/your-username/recode-website.git
cd recodehive-website
docker-compose up
npm run build
npm run serve
If you'd like to contribute to recode hive, please follow these guidelines:
- Fork the repository and clone it locally.
- Create a new branch for your feature or bug fix:
git checkout -b feature-name
- Make your changes and test thoroughly.
- Commit your changes:
git commit -m "Brief description of your changes"
- Push to the branch:
git push origin feature-name
- Submit a pull request detailing your changes.
- Framework & Libraries: Docusaurus 3 (React + TypeScript)
- Language: TypeScript (Node.js β₯ 18)
- Styling: Tailwind CSS 4
- UI Components: Radix UI, Framer Motion
- Linting & Formatting: ESLint, Prettier
- Type Checking: TypeScript (
tsc
)
recode-website/
|
βββ .github/ πΉ GitHub meta files
| βββ ISSUE_TEMPLATE/
| βββ workflows/
| βββ pull_request_template.md
βββ blog/ πΉProject Blog
| βββ git-coding-agent/
| βββ google-backlinks/
| βββ...
βββ community/ πΉ Contributor Docs
| βββ contributing-guidelines.md
| βββ index.md
| βββ our-documentation.md
| βββ understand-lint-checks.md
βββ docs/ πΉDocumentation
| βββ GitHub/
| βββ Google-Student-Ambassador/
| βββ ...
βββ src/ πΉSource Code
| βββ components/
| βββ css/
| βββ custom.css
| βββ data/
| βββ database/
| βββ lib/
| βββ pages/
| βββ plugins/
| βββ services/
| βββ style/
| βββ globals.css
| βββ theme/
| βββ utils/
βββ static/ πΉ Public Assets
| βββ icons, img
| βββ .nojekyll
| βββ *.png
βββ .gitignore
βββ CODE_OF_CONDUCT.md
βββ LICENSE
βββ README.md
βββ ...
This project is open source and available under the MIT License.