A comprehensive glossary of tech terms and concepts, designed to help newcomers and tech enthusiasts understand the most common terminology in the technology world.

TechTerms is an open-source glossary application that makes complex technical terminology accessible to everyone. Whether you're a newcomer to tech or an experienced developer, this platform helps you understand and learn the most common tech terms and concepts.

• 📚 Comprehensive Glossary: Browse through multiple tech terms with clear, beginner-friendly explanations
• 🏷️ Categorized Content: Terms organized by categories like Web Development, DevOps, Software Architecture, and more
• 🔍 Smart Search: Find terms quickly with our search functionality
• 🌐 Open Source: Contribute new terms, improve definitions, or add features
• ⚡ Fast & Lightweight: Built with modern web technologies for optimal performance

• Web Development: APIs, REST, frontend/backend concepts
• DevOps: Docker, CI/CD, deployment strategies
• Software Architecture: Microservices, MVC, design patterns
• Software Engineering: OOP, SOLID principles, testing
• Version Control: Git workflows and best practices
• Database: Data management and storage concepts

TechTerms uses privacy-first analytics to understand usage patterns. View our public analytics dashboard:

• View Analytics Dashboard

This public dashboard provides insights into how the platform is being used and can be used for advertising purposes.

TechTerms is built with a minimal, beginner-friendly tech stack:

• Astro - Static site generator for fast, content-focused websites
• Tailwind CSS - Utility-first CSS framework for rapid UI development
• TypeScript - Type-safe JavaScript
• GitHub Pages - Free hosting and automatic deployments

• Node.js (version 22 or higher)
• npm package manager

1. Clone the repository

   git clone https://github.com/techterms/techterms.git
   cd techterms

2. Install dependencies

   npm install

3. Start the development server

   npm run dev

4. Open your browser Navigate to http://localhost:4321 to see the application running locally.

• npm run dev - Start development server
• npm run build - Build for production
• npm run preview - Preview production build
• npm run lint - Run ESLint
• npm run lint:fix - Fix ESLint issues
• npm run format - Format code with Prettier
• npm run format:check - Check code formatting

Adding new tech terms is easy! Here's how:

1. Edit the definitions file Open src/data/definitions.ts and add your new term:

   {
     id: 'your-term-id',
     term: 'Your Term',
     explanation: 'A clear, beginner-friendly explanation of the term.',
     categories: [Categories.WebDevelopment], // Choose relevant categories
     related: [
       'https://example.com/more-info',
       'https://docs.example.com/term'
     ],
   }

2. Choose categories Available categories are defined in src/models/Categories.ts:

3. Follow the guidelines

   • Keep explanations clear and beginner-friendly
   • Include relevant external links for further reading
   • Use proper grammar and formatting

We welcome contributions from everyone! Whether you want to:

• 🧠 Add new tech terms
• 📝 Improve existing definitions
• 🐛 Fix bugs
• 🎨 Improve the UI/UX
• 📚 Enhance documentation

Please read our Contributing Guide for detailed instructions on how to contribute to the project.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run formatting and linting: npm run format && npm run lint:fix
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

The application is automatically deployed to GitHub Pages when changes are merged to the main branch. The deployment process includes:

• ✅ Code formatting checks
• ✅ Linting validation
• ✅ Build verification
• 🚀 Automatic deployment to https://techterms.io

This project is licensed under the MIT License - see the LICENSE file for details.

• Thanks to all contributors who help make tech terminology more accessible
• Built with Astro and Tailwind CSS
• Hosted on GitHub Pages

• 🐛 Found a bug? Open an issue
• 💡 Have a suggestion? Create a feature request
• 📚 Need help? Check our Contributing Guide

Made with ❤️ for the tech community