This repository contains the source code for the TechHut website. It is built using Next.js with MDX support, a modern React framework for building static and dynamic websites.
We're glad that you want to contribute!
- node 16+
- npm 8+
$ npm install
$ npm run dev
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a fork. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.
Once your pull request is created, a TechHut reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the reviewer.
Internal documentation for contributors and maintainers:
- Documentation Index
- Project Structure
- Content Authoring Guide
- Authors System
- Components Reference
- MDX Components
- Build Scripts
- Styling Guide
- Deployment
The website's original source code and reusable components are open source under the BSD 3-Clause License. This includes layouts, styles, scripts, configuration, tests, and developer documentation. The software license terms follow the standard BSD 3-Clause license.
Written content and articles are copyright protected and are not included in the software license. Original articles, tutorials, guides, reviews, app descriptions, and accompanying original media are reserved to TechHut Media and their respective authors, unless separately licensed. This also applies to copies and excerpts in generated data, feeds, and rendered pages. See CONTENT-LICENSE for the content terms, including legally permitted uses.
TechHut branding is not open source. The TechHut names, TECH/HUT wordmark, logos, favicons, and other TechHut brand artwork are excluded from the software license, even when embedded in a component. Reusing the code does not grant permission to brand your project as TechHut or imply its endorsement. See BRANDING.md for details, including replacing branding in independent deployments while preserving required software copyright notices.
Third-party code and assets retain their own licenses and notices. In particular, app logos and other third-party artwork are not relicensed by this repository; see their provenance and notices in public/app-icons.
TechHut thrives on community participation, and we appreciate your contributions to our website!