Skip to content

Latest commit

 

History

History
129 lines (83 loc) · 7.39 KB

README.md

File metadata and controls

129 lines (83 loc) · 7.39 KB
Raw

License Shield Contributors Issues KanBan Shield

ShoCase

Description

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

Built With

Express Shield Sequelize Shield mySQL Shield Heroku Shield Handlebars Shield Materialize Shield Node.js Shield JavaScript Shield HTML Shield CSS Shield

Table of Contents

Installation

ShoCase™ is a deployed web application. Most users must simply navigate to shocase.herokuapp.com/

example deployed site

Should you wish to download the project locally you must:

  1. 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
  2. Install NPM packages 
    npm i
  3. Create a .env and input 
    DB_NAME= 'shocase_db'
DB_USER= 'YOUR-USER-NAME'
DB_PASSWORD= 'YOUR-PASSWORD'
  4. Run the schema housed within the db folder

(back to top)

Usage

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.

example 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 the Unlike 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 and Delete your playlists once you are on your Profile

(back to top)

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact And Contributors

For any further questions feel free to contact us via:

(back to top)

Acknowledgments

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.

(back to top)