The project is an open-source dictionary app that focuses on providing meanings and explanations for software engineering and tech-related jargon. It allows users to easily access and read definitions for various terms. Additionally, the app also allows contributors to contribute new words and their meanings to the dictionary, ensuring that the content stays up-to-date and comprehensive.

Proposal

• Keep each word in a directory with one word per mdx file.
• Each mdx file will carry definitions and meanings of the respective word.
• Utilize a static site generator with an mdx loader to index these directory individual word files as single pages.
• Create a search engine on the website using the flexsearch library.
• Create a visual editor on the web app
• Enable users to contribute new words or improve existing words in the dictionary
• Provide a user-friendly interface for making edits or additions
• Utilize GitHub APIs for handling the contribution process
  • Create a fork of the repository for first-time contributors
  • Create a branch for editing or adding a new file
  • Create a pull request for submitting the changes
• Streamline the contribution process and make it easier for users to contribute to the dictionary

System Architecture

Excalidraw — Collaborative whiteboarding made easy

Scripts

Fork Repository Script

To automate the process of forking our repository's main development branch to the account of an authenticated user, we can utilize the GitHub REST API and the Octokit.js library. Here is an example script written in JavaScript that demonstrates how this can be achieved using Octokit.js:

const { Octokit } = require("@octokit/rest");

async function forkRepository(repoOwner, repoName, accessToken) {
  const octokit = new Octokit({
    auth: accessToken,
  });

  try {
    const response = await octokit.repos.createFork({
      owner: repoOwner,
      repo: repoName,
    });

    if (response.status === 202) {
      console.log("Forking process initiated successfully!");
    } else {
      console.log("Error occurred while forking repository.");
    }
  } catch (error) {
    console.log("Error occurred while forking repository:", error);
  }
}

// Example usage
const repoOwner = "your_username";
const repoName = "your_repository_name";
const accessToken = "your_github_access_token";

forkRepository(repoOwner, repoName, accessToken);

The script use the Octokit.js library to interact with the GitHub REST API. It requires the repository owner's username, the repository name, and an access token with the necessary permissions to fork repositories. The forkRepository function makes use of the repos.createFork method provided by Octokit to initiate the forking process. Upon successful initiation of the forking process, the script will output a success message. Otherwise, it will display an error message.