ShoCase™ is a full stack web application that serves as a social media platform for sharing anime reccomendations through a playlist format. The user is able to make playlists of 4 animes, comment on other users playlists, and save playlists within their liked page. For more information check out the PowerPoint.
The project utilizes an Express backend, RESTFUL api, mySQL database, and a third party API.
While building this project we learned to:
- Make various calls to a database model and serve them to the front end
- Utilize handlebars to display multiple unique pages for our app
- Create Models, associate them too each other, and seed those Models with data
- Organize third party API responses into a request body in order to store that information in our database
ShoCase™ is a deployed web application. Most users must simply navigate to shocase.herokuapp.com/
Should you wish to download the project locally you must:
- Open your terminal and clone the repo
SSH: git clone git@github.com:Bfunk54/ShoCase.git HTTPS: git clone https://github.com/Bfunk54/ShoCase.git
- Install NPM packages
npm i
- Create a
.env
and inputDB_NAME= 'shocase_db' DB_USER= 'YOUR-USER-NAME' DB_PASSWORD= 'YOUR-PASSWORD'
- Run the
schema
housed within the db folder
When navigating to the homepage you will be greeted with all playlists other users have made. Before being able to interact you must first either Login
or Signup
. In order to do this click on the hamburger icon within the Nav Bar. You will be redirected to the login page.
Once logged in you can finally interact with our page! To list a few functions of our webstie, you can:
- Search for a specific playlist using the
search bar
at the top of the screen - Create a new playlist using the
+
button at the top of the screen - Like a playlist by clicking the
Like Button
and unlike by clicking theUnlike Button
- Select a playlist by clicking on its title to be brought to a
Comments
page where you can view other comments and create comments of your own - View all of your created playlists by opening the navbar and selecting
Profile
- View all playlists you have liked by opening the navbar and selecting
Likes
Update
andDelete
your playlists once you are on your Profile
If you have a suggestion that would make the repo 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!
- Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
For any further questions feel free to contact us via:
-
Project Link: github.com/Bfunk54/ShoCase
Special thanks to these resources. You have proven invaluable to creating this project:
Fair Use
Copyright Disclaimer under section 107 of the Copyright Act of 1976 allows fair use of copyrighted material for purposes such as "teaching... or research.
Fair use allows limited use of copyrighted material without requiring permission from the rights holders. It provides for the legal, non-licensed citation or incorporation of copyrighted material in another author's work under a four-factor balancing test. To find out more information about the Fair Use Act, please click here.
For information on each resource used on this project, please click the resource name below.