Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 2.72 KB

README.md

File metadata and controls

81 lines (51 loc) · 2.72 KB
Raw
jargons.dev

jargons.dev

The Software Engineering Dictionary

About

jargons.dev is an open source dictionary curated by contributors providing simplified meaning and definitions to software development, engineering, and general technology terms.

Tech Stack

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

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 create test repo

    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.

Contributing

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

  1. Dictionary Word Contribution: This includes adding new words to the dictionary or editing existing word entries. We highly recommend using our Jargons Editor at jargons.dev/editor for this purpose. This user-friendly interface streamlines your contribution allowing it end up as a pull request.

  2. Other Contributions: These are contributions other than adding or editing words in the dictionary, feel free to contribute in other ways such as issue reporting/triaging, code/documentation improvements, bug fixes, or feature enhancements.

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 ⭐️