Skip to content

Nevish-302/SeenIt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

SeenIt

Interactive Entertainment Database
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Information
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Authors
  10. Acknowledgments

About The Project

Interactive Entertainment Database
A Webapp where you can save progress of Anime/ Manga/ TV Series/ AsianDramas that you are watching or have already watched a few times. You can track how many hours you've spent in each of those and share it with others as well. You can also search info for TV shows and anime you might wanna add. Lastly, you can customize your profile here.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

pip install cs50
pip install Flask
pip install Flask-Session
pip install psycopg2-binary
pip install requests
pip install Flask-mail
pip install requests
pip install mail
pip install sqlite3
pip install Flask-APScheduler

(back to top)

Installation

Clone Project:

git clone git@github.com/Nevish-302/SeenIt.git

Install Prerequisites

Database

Create a new database SeenIt.db and replace the one provided by it.

sqlite3 SeenIt.db

Execute the following commands.

CREATE TABLE users (id INTEGER, username TEXT NOT NULL, hash TEXT NOT NULL, tablename TEXT NOT NULL, confirmation INTEGER, PRIMARY KEY(id));

CREATE TABLE personalinfo(id INTEGER NOT NULL, name TEXT, gender TEXT, age INTEGER, FAV TEXT, profilepic INTEGER);

Flask Mail

You will need to export your username password and sender email:

export MAIL_DEFAULT_SENDER=SeenIt
export API_KEY_JIKAN=#YOUR_API_IMDB_KEY#
export API_KEY_IMDB=#YOUR_API_IMDB_KEY#
export MAIL_PASSWORD=#YOUR_PASSWORD_HERE#
export MAIL_USERNAME=YOUR_USERNAME_HERE#

You can get your IMDB API KEY at https://imdb-api.com/
You can get your JIKAN API KEY at https://rapidapi.com/theapiguy/api/jikan1/
FYI both of these are free

Flask

Start flask:

flask run

Usage

  • Password protected login
  • Email confirmation
  • Index page
    • Click on any of the tabs to view selected type only
    • Search on local search to search through already added data
  • Add / Update page
    • Input information in the boxes provided and click on add
    • Select the row and the column to update, input information and click on update
    • Select the id of the row to be deleted and click on delete
  • Search Page
    • input information in any of the boxes provided and search
    • The information is returned from already existing APIs (IMDB and JIKAN)
  • ME page
    • your stats (graph and other information) and profile is displayed here
  • Settings page (settings icon in navbar)
    • Type once in password, again in confirm password field and click on change password to do so
    • Type info and select the type of info you want to change in your profile
    • Names of the profile pictures available are provided below
  • User Search Page
    • You can search for lists and profiles of other users in this tab
    • Note that it is not mandatory to have an id on the website to use this feature

For more examples, please refer to the Documentation

(back to top)

Information

Screenshots of the application below:

Laptop / PC

Login Page

Screenshot 1

Index Page

Screenshot 2

Add/Update Page

Screenshot 3

Search Page

Screenshot 4

Anime SearchResult Page

Screenshot 5

TV series SearchResult Page

Screenshot 6

ME Page

Screenshot 7

UserSearch Page

Screenshot 8

Settings Page

Screenshot 9

Mobile

Login Page

Screenshot 1

Index Page

Screenshot 2

Add/Update Page

Screenshot 3

Search Page

Screenshot 4

Index With Creator Info and menu open

Screenshot 5

TV series SearchResult Page

Screenshot 6

ME Page

Screenshot 7

UserSearch Page

Screenshot 8

Settings Page

Screenshot 9

(back to top)

Roadmap

New Technologies

  • Flask-mail
  • IMDB API
  • JINKAN API
  • Flask-mail
  • Flask-Markdown
  • Token Email verification

Web Framework (Flask | Gunicorn)

  • Register
  • Flask email (resister confirmation)
    • Token email confirmation
  • Login
  • Index (list of shows watched)
    • Local Search
    • Type Wise Data View
  • Add/update
    • Add Data
    • Modify Data
    • Delete Data
  • Search
    • TV Series Search
    • Anime Search
  • Me
    • Total Time Spent and Type Wise Spent
    • Bar Graph Base On TypeWise
  • User Search
    • Search for users other than you as long as you have their email id
    • This feature can be used without login/registration as well
  • Settings
    • Verify Personal Data
    • Change Profile Picture
  • My contact info
    • As Footer In Each Page on PCs
    • As An Expandable footer On Each Page on mobiles
  • Logout
  • Render this README as about page

Front-end (HTML | CSS | JS | Bootstrap)

  • styles.css
    • different css for mobiles and laptops
    • responsive css
  • login.html
  • index.html
  • addupdate.html
  • apology.html
  • change.html
  • confirmemail.com
  • layout.html
  • myself.html
  • results.html
  • resultsanime.html
  • search.html
  • userresult.html
  • usrsearch.html
  • Bootstrap
    • Tables
    • Part Of Forms
    • Dropdown Navbar Specifically For Mobiles
  • Owner Info Dropdown Menu Specifically For Mobiles
  • Favicon, and many png images used throughout the app (thank you pngwing.com)

Database (SQLite3)

  • User table
  • Personal Info table
  • List tables for every user
  • Menu table
  • Email confirmation column

Deployment (Github | Heroku)

  • Github
  • Connect Github to Heroku
  • Manual deployment

README

  • Name
  • Local Setup
  • Screenshots
  • Authors
  • Contributing
  • License
  • Road Map

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this 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/SeenIt)
  3. Commit your Changes (git commit -m 'Add some Feature')
  4. Push to the Branch (git push origin feature/SeenIt)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Your Name - @nevish_302 - shiven302@gmail.com

Project Link: https://github.com/Nevish-302/SeenIt

(back to top)

Authors

(back to top)

Credits

(back to top)