SNAPS (Spawning Nice Acronyms for People with Style)

Description

Duration: 2 weeks

Description

This is an acronym generator. A user inputs words to describe something, and the app takes those words and synonyms of those words and combine them to create acronyms that are also words. Users can browse these acronyms and word lists.
If they log in, they can choose their favorite acronyms and word lists to be saved to their profile. They can also flag acronyms that they don't believe are words.

Prerequisites

• Node.js
• react
• redux
• postgres

Installation

1. Run npm install
2. Create a database called acronym on your local postgreSQL server. Update server\modules\pool.js as needed for username and password of your postgreSQL server
3. Run the SQL commands found in database.sql
4. Run npm run build to build a local react app
5. Run npm run server to run the server.
6. Go to localhost:5000

An online version of this app is available here.

Usage

The + button adds more field and the X button removes fields. Without AWS integration, the limit is 5 words, and it is 7 words with AWS integration.

After a short delay, the a list of acronyms will be displayed.

Pressing the down caret will display lists of words that make up the acronym.

Pressing heart will favorite an acronym or word list if the user is logged in or prompt the user to log in.

Pressing the flag will send the word to be reviewed by the admin to see if it is a real word or not.

Users are able to review their favorites to remove or edit the words there.

Built With

Javascript

• Node.js
• express
• pg
• react
• redux
• material-ui
• passport
• bcrypt

SQL

• postgreSQL
• pgAdmin 4

AWS

• Lambda
• S3
• Redshift

Known bugs

• There is no current error handling, so users will not be notified if there are any login/registration errors.

Support

Contact [email protected] for any questions, concerns, or bug reports.