Skip to content

Wruqe/SlApiI

Repository files navigation

slAPI

License

Description

"slAPI", a pun of slappy, is a web application that serves as a repository for all things silly and whimsical. Users can explore a collection of funny and quirky data, as well as contribute their own by adding new silly entries.

Along with these contributions, users can rate other's posts. These ratings calculate our an average score, showing all users what their average rating on the platform is.

While there, users can interact with one another in the chat-box, allowing for me tomfoolery and ballyhoo to take place in real time.

Website: slAPI Land

YouTueb: SillyAPI Land Video Demonstration

SillyAPI Land Homepage

Login & Signup Page

Logged In Display

Create Post

Rate Post

Tabel of Contents

User Story

AS A user of web applications/social media and comedic genious

I WANT to be able to post all thing funny and whimsickle on a platform

SO THAT other can see what I post, then comment and rate what is posted

Acceptance Criteria

GIVEN a functional web based application for tomfoolery and shennanigans

WHEN presented with homepage
THEN can view a nav bar with a home route and login, along with all posts that have been created and the number of likes per post

WHEN clicking on a post
THEN if not logged the user is redirected to the login page, if logged in directed that post's page.

WHEN when a user completes member signup
THEN their password is encripted and they are redirect to the profile page

WHEN already a user
THEN you can login with your email and password and will be redirect to the profile page

WHEN a user enters a title and content and clicks the create button
THEN a post is created below current posts

WHEN a user clicks the delete button
THEN the post is deleted

WHEN a user clicks on the post created
THEN the user is redirected to the post's page

WHEN a user clicks on the like post
THEN the number of likes increases

WHEN a user clicks on the any number of starts for a rating
THEN the stars change color based on what is chosen

WHEN a user clicks submit stars
THEN the rating of stars is submitted(feature currently not working)

WHEN a user clicks on the slAPI Profile in the nav bar
THEN they are redirected to their profile page

WHEN a user clicks on the chat in the nav bar
THEN a chat box appears in the bottom corner and can be used to chat with othe rusers

WHEN when the user clicks logout on the nav bar
THEN the user is logged out and redirected to the homepage

Installation

No installation needed. App is deplayed on Heroku.

Technologies

MySQL

Heroku

Node.js

Javascript

Packages

The following npm packages were also used:

MySQL2
bcrypt
dotenv
nodemon
Sequelize
socket.io
express.js
express-session
express-handlebars
connect-session-sequelize

License

PLACEHOLDER UNTIL WE DECIDE WHICH LICENSE TO WE WANT TO USE

License

MIT License

Copyright 2024: Conor Allen, Whitney Simpson, Ernest Jones, Greg Greve & Heinz Ulrich V

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributing

GitHub Badge

Tests

None currently

Resources

Socket.IO

Questions/Contact

See Contributing or send one of us an email!

Conor Allen
Whitney Simpson
Ernest Jones
Greg Greve
Heinz Ulrich V

About

Full-stack Social meme and blog website

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published