🎉 Welcome to Abbreve

Abbreve is an open source dictionary for slangs. Writing on the internet is currently the most common way of communication, but keeping up with the abbreviation-style is becoming difficult.

Abbreve helps you keep up, by providing meanings to these abbreviations.

🎥 Project Overview

You can check out the live project here

All you need to do is start entering a slang in the search bar, and the meaning will be provided. Below the main meaning of the slang could be alternative meanings.

📣 Want to contribute?

We would love to have you! Abbreve is open source and we are keen on hearing what you have to say. Do check out the code of conduct for rules and guidelines.

💡 Getting Started

Found a bug? Accessibility issue? Or do you want to add an abbreviation to our database? Then go right ahead and create an issue.

Tech Stack

This project uses;

To start contributing,

Prerequisites

You need to have,

Node installed
Basic knowledge of Git

Steps

Fork this repositiory
In your terminal, clone your fork using git clone <link to your fork>
Run cd Abbreve to navigate to project directory.
Run npm install to add node_modules folder.
To start the server on localhost, run npm run dev.

This project uses Vite, but that shouldn't overwhelm you. Everything works pretty much the same.

Make your changes, push, and open a pull request.

Adding an abbreviation

Before adding an abbreviation, please make sure that the new entry does not already exist. You can easily check this by entering the slang on the live site to see if gives a result or not.

For now, we use JSON to store the abbreviations. We hope to improve on this as time goes on

In the /public folder, open the /server folder and subsequently, the db.json file you find in it. You can see that each slang is a JSON object of its own with a definition and alternatives.
To add a new abbreviation, you must append a new object to this file.
- The slang must be in lowercase. For example, lgtm not LGTM
- The first letter of each word in the definition and alternatives must be uppercase. For example, Looks Good To Me
The Screenshot below could help
- The highlighted section is an example of the way you would add an abbreviation.
- Before you add a new object, end the one above with a comma. If not, there will be errors in your JSON. Your IDE should indicate this.
If a slang does not have alternatives, add only a definition

Only English slangs are accepted as of yet.

💣 Now, GO CREATE THOSE ISSUES AND PULL REQUESTS!

🔑 License

This project is licensed with Apache 2.0

Don't forget to star ⭐ this project if you like it. All support is highly appreciated 💯

Sqaarf/Abbreve