jargons.dev is an open source developer literacy and education platform. It helps people understand software development, engineering, and technology through community-created learning resources. The dictionary is its first content collection, with room to grow into additional formats.
jargons.dev is built using the following open source technologies:
- Astro - Web framework for building content-driven websites
- React - Library for building web interfaces
- Tailwind CSS - A Utility-first CSS Library
- Vercel AI SDK - Toolkit for building AI-powered features
- LangChain - Framework for developing applications powered by large language models (LLMs)
See https://excalidraw.com/#json=LNystqH62oqkWZaBLQ8l3,daK21Ngah4Vo1LRMcGipCg
To run the project locally running on your machine, follow these simple steps.
To run the project locally, ensure your machine has Node.js installed. The project requires Node.js version 19 or higher. If you don't have Node.js installed, you can download it from the Node.js website.
To get set-up follow these steps:
-
Clone the repository:
git clone https://github.com/jargonsdev/jargons.dev.git
-
Navigate to the project directory:
cd jargons.dev -
Install dependencies:
npm ci
-
Run the
dev/setupscript and configure a content repositoryThis script streamlines the process of creating a GitHub App required to run jargons.dev locally and sets up the environment file (.env) for you; Learn more at dev/setup
npm run setup
-
Start the development server:
npm start
-
Open your browser and visit
http://localhost:4321to view the project.
jargons.dev includes ✨jAI (jargons.dev AI) - an intelligent assistant that helps users explore and understand software engineering terms through AI-powered interactions. Learn more in the apps/jai module.
To enable ✨jAI, you need to seed the vector store with dictionary content that ✨jAI uses for its knowledge base:
npm run seed:jaiThis script prepares the vector store with processed dictionary content, enabling ✨jAI to provide intelligent responses and semantic search capabilities.
Learn more about ✨jAI setup for detailed configuration and usage instructions.
jargons.dev implements comprehensive testing to ensure code quality and reliability.
npm run test # Run all tests
npm run test:coverage # Generate coverage reportView detailed testing documentation for test structure, writing guidelines, and phase-based testing strategy.
We welcome contributions to jargons.dev! There are two main ways you can contribute to:
-
Content Contribution: Use the Jargons Editor at jargons.dev/editor to suggest dictionary changes. Content is maintained in the separate jargonsdev/content repository; see its README for direct contribution guidance.
-
Core Contributions: For issue reporting, code and documentation improvements, bug fixes, or feature enhancements to the website, contribute to this repository.
To get started with contributing, please refer to our Contribution Guide. Thank you for contributing to the jargons.dev project!
Do leave the project a star ⭐️