Guests can enter the site using the following credentials
Username: plauditapp@gmail.com | Password: guest
Plaudit! is a workplace application that lets you publically applaud the achievements of your peers and employees. We believe workplace culture should not only encourage positive feedback, but celebrate it!
Plaudit allows users to publically recognize their co-workers' achievements via an awards system. The most recent awards are displayed in an activity feed on the home page. Awards given to (or by) a user will also be visible on their profile page.
When a user receives a badge, they are notified via email. Their direct supervisor is also notified of the award.
Use the autocompleting search bar to find members and see their profile pages, which also include a user's photo and contact information.
The app is designed to be simple and easy to use, and is fully responsive.
We recognize that each organization is unique, so we designed Plaudit to be highly customizable. The information on each user's profile page can be tailored for your needs, and the color scheme can be altered to match your brand. In addition, an organization can choose to use different award icons and assign specific meanings to each type of award. For example, you may choose to include different tiers (a small award for cleaning a supply closet, a giant award for working 36 hours straight to launch a new product), or simply categorize the awards to fit your unique style (a "great idea" award, an "extra effort" award, a "helpfulness" award, etc).
Plaudit users may only register for the site once they exist in the organization/company database - this will seed basic information about each user, including their name, email, work phone number, position and supervisor. A new user registers by creating a password and including any extra information that will be displayed on their profile page (currently we incorporate a "fun fact" about the user). The encrypted password and extra information is then stored in a second database table.
Once a user logs in, they see a feed of all the awards recently given to other members of their organization. From here, they can access their own profile page, search for the profile page of another user, or give a badge to another user.
When giving a badge, a user can choose to give a co-worker a number of different awards (currently represented by a crown, a trophy, a star and a lightbulb) and include a message to accompany the award. The activity will be visible on the home page and profile pages of those involved. A notification email is also sent to both the user and their direct supervisor so that the recognition does not go unnoticed.
- mySQL
- Heroku
- JawsDB MySQL
- bcrypt
- body-parser
- connect-ensure-login
- cookie-parser
- express-session
- nodemailer
- passport
- random-string
- sequelize
- session-store
- CSS
- Handlebars
- HTML
- GreenSock
- Google Fonts
- Javascript
- jQuery
- Materialize
- Sequelize
Clone or download the repository to your desktop.
Users will need Google Chrome web browser for testing the application and Sublime (or another tool) for viewing/editing the code. Users will also need to install the npm packages (provided in the package.json and listed above under "Technologies Used") via the terminal and use MySQL Workbench in order to establish a database.
Download or clone the repository to your desktop. Create a database in MySQL Workbench entitled "star_power." Seed it with the data from the document seed_data or add your own data into the MySQL database. Don't forget to update config.json with your credentials.
Navigate to the file folder that holds the Plaudit! files in the terminal. Type "npm i --s". Then run the server: "node server.js"
From there, navigate to localhost:8080 in your browser to open up the landing page of the website. Create an account based on one of the established seeds and log in. Once logged in, you will be taken to the index.handlebars page where the main activity feed is located.
Search for other users using the search bar. The hamburger menu (upper left) will trigger a side nav for various pages, allowing a user to visit their profile page, give a badge, etc. Users can also log out from the side nav.
Profile pages display the profile owner's name, headshot, work role, phone number, email address, and LinkedIn profile link. Below this is an activity feed specific to the profile owner.
The Give a Badge page offers a brief form in which the user can enter the name of a recipient, select one of four colorful badges, and enter a message for their recipient. Clicking the submit button will push the badge to the activity feed, the recipient and the user's activity feeds, and take the user to main activity feed.
The FAQ page lists commonly asked questions and their corresponding answers in a collapsible format.
The log out function in the side nav returns the user to the landing page.
Please refer to the repository files for coding samples; the sections are commented to indicate their functionality.
If you have any questions about how or why something works, feel free to contact a member of the Project Team for details!
- Michelle Didier meeshyd
- Susan Heiniger SusanArend
- Adam McNerney NorthNern
- Rebecca Palmore rpalmore
- Yilin Xu yilinxu
Hat tip for help, inspiration, and patience to:
- Steven Daoud
- Nate Johnson
- Ethan Romba
- Chris Mendoza
- Liz Wylie
- Kurt Schlueter