Skip to content

About

[In transition] Building a community-driven developer literacy and education platform.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

59 stars

Watchers

3 watching

Forks

jargons.dev

jargons.dev

The Developer Literacy and Education Platform

About

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.

Tech Stack and Architecture

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)

System Architecture

See https://excalidraw.com/#json=LNystqH62oqkWZaBLQ8l3,daK21Ngah4Vo1LRMcGipCg

Run Project Locally

To run the project locally running on your machine, follow these simple steps.

Prerequisite

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.

Setup

To get set-up follow these steps:

  1. Clone the repository:

    git clone https://github.com/jargonsdev/jargons.dev.git
  2. Navigate to the project directory:

    cd jargons.dev
  3. Install dependencies:

    npm ci
  4. Run the dev/setup script and configure a content repository

    This 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
  5. Start the development server:

    npm start
  6. Open your browser and visit http://localhost:4321 to view the project.

AI Features - Powering ✨jAI

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.

Setup ✨jAI

To enable ✨jAI, you need to seed the vector store with dictionary content that ✨jAI uses for its knowledge base:

npm run seed:jai

This 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.

Testing

jargons.dev implements comprehensive testing to ensure code quality and reliability.

Quick Start

npm run test          # Run all tests
npm run test:coverage # Generate coverage report

View detailed testing documentation for test structure, writing guidelines, and phase-based testing strategy.

Contributing

We welcome contributions to jargons.dev! There are two main ways you can contribute to:

  1. 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.

  2. 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!

Support

Do leave the project a star ⭐️

About

[In transition] Building a community-driven developer literacy and education platform.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

59 stars

Watchers

3 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages