Build a tool to understand your companys internal language with SanityCMS

Purpose

This is a simple search app that allows new and existing employees to quickly search for terms, definitions, and acronyms for commonly used phrases within Consulting or Corporate workplaces.

The idea is to have a quick and accessible means for people to search for concepts without having to ask that dreaded 'silly question' of 'what does that mean' in a meeting.

The main intention is to support newly onboarded colleagues, or those of us who have a forgetful mind!

Preview

• Check out the website here on Vercel: Jargon Buster

How It's Built

The application itself is probably 'over-engineered' for it's current purpose, however the intent behind the architecture chosen is to easily support and facilitate expansion of features and requirements depending on the companies use-case.

The interesting bit about this application in my opinion is the support for techy people and non-techy people. The search function has the option to use one of two diffrent sources when searching for content.

Excel Parsing

Within the app, there's an embedded excel spreadsheet that can be updated when new content needs added or old content needs to be removed. Simply make your changes in excel, then run the commands at the bottom of this document to deploy them.

SanityCMS

Sanity offers a more dynamic approach to making changes. This tool can be used to make updates without having to redeploy - this is certainly a win win for both sides as the CMS tool is infinitely customisable for those of you that want to tinker with the code base, as well as being straight-forward for non-technical users to add and update terms without having to make any changes to the codebase, or having to jump through hoops for redploying. Simply update the CMS, and your changes will be live.

Tools

• React
• TypeScript
• NextJS
• Zod
• ShadCN UI
• Tailwind CSS
• Vercel

Data Sources

• Sanity CMS
• Excel Spreadsheet

How It's Configured

• Inside env.example you can swap the Data Source being pulled into the app.
• Swap the values for NEXT_PUBLIC_ENVIRONMENT depending on what data source you want to use.

Find out more

• Check out the GitHub here: GitHub: Jargon Buster
• Ask me any questions here: Portfolio: Brendan Campbell