README.md

UW Acronym Finder

A simple app to search through acronyms at UWaterloo.
Explore the docs »

🚀 View Live · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Contact
6. Acknowledgments

About The Project

The UW Acronym Finder is your go-to tool for decoding the myriad of acronyms you'll encounter at the University of Waterloo. Whether you're a new student trying to make sense of the campus lingo or a seasoned professor needing a quick reference, this search engine has got you covered.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/a4ojha/uw_acronym_finder.git

2. Install NPM packages

   npm install

3. Run the development server

   npm run dev
   

(back to top)

Usage

There are two main features of this search engine

1. Search by acronym
   Simply type in an acronym, and you'll instantly see the full name and details.

2. Search by full name
   Know the full name but not the acronym? No problem! Enter the full name, and we'll show you the corresponding acronym.
   

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Adon Ojha - @adon_05

Project Link: https://uw-acronym-finder.vercel.app

(back to top)