GithubHelp home page GithubHelp logo

brittanyrw / emojiscreen Goto Github PK

View Code? Open in Web Editor NEW
149.0 9.0 348.0 42.05 MB

EmojiScreen is a listing of movies, TV shows and musicals depicted through emojis.

Home Page: https://emojiscreen.com

License: GNU General Public License v3.0

JavaScript 85.13% HTML 4.81% CSS 10.06%
emojis musicals tv-shows movies beginner-friendly hacktoberfest

emojiscreen's Introduction

EmojiScreen πŸ“Ί

A listing of movies, TV shows and musicals depicted through emojis.

Visit emojiscreen.com

Screenshot of Emojiscreen homepage

Contributing Guidelines 🎁

Below are some guidelines to follow when contributing to this project.

Adding a Movie, TV show or Musical

To add a show or movie to this project, you will need to first check the project in the movies.js, tv.js, or musicals.js files to make sure that the movie or show you would like to add is not already in the project. Once you confirm the item you want to add is not already in the project, open an Issue stating what you would like to add. Once you get approval for the Issue, move on to adding your item to the code.

You will add an Emoji Card inside of the movies.js, tv.js, or musicals.js files in the data folder. Each file is made up of an array (a list) of objects. You will add a new object for your show or movie into the appropriate file. Please note: The musicals.js file is for live musicals (such as Broadway and West End shows). Movie musicals should be added to the movies.js file.

Below is an example of what a show looks like on the website:

Screenshot of Beauty and the Beast Emoji Card

In the emoji JavaScript files, each Emoji Card consists of the following object:

{
  title: "Beauty and the Beast",
  emojiImgs: "🏰πŸ₯€πŸŽΆπŸ“šπŸ•°οΈ",
  genres: ["animation", "family", "fantasy"],
  itemLink: "https://www.imdb.com/title/tt0101414/",
  type: "movie",
  year: 1991
}

Required reading:

View the Card Overview for details on each part of the emoji object.

Walkthroughs

Below are detailed walkthroughs on how to add a show or movie to EmojiScreen.

Adding or Updating Features Contributions

  • Find an Issue that you would like to complete or create an Issue if you have an idea for a new feature.
  • If someone is already assigned an Issue, please move on to another Issue. If the Issue has not been assigned, comment inside of the Issue stating that you would like to work on that item. If you are not assigned to an Issue, your PR will not be accepted for that Issue.
  • After you receive confirmation, complete the Issue and submit a Pull Request.

🚨 Wait for confirmation from the maintainers before working on the Issue. If you submit a PR without being assigned an Issue for a feature, your PR will be closed and you will not be assigned the Issue.

If you would like to suggest a new feature, create an Issue and outline what it is you think should be added or updated. This project was created to help beginners, so keep that in mind when suggesting new things. Wait for confirmation before working on the Issue.

⭐️ Important Notes

  • The Card Overview includes all of the instructions for adding a show or movie.
  • Search the movies.js, tv.js, or musicals.js files and current open pull requests to make sure you are not adding a duplicate.
  • Make sure your emojis actually depict the show or movie. Someone should be able to guess what the show or movie is based on the emojis you choose.
  • If you are adding multiple items, please include them in one pull request.
  • Go through this checklist to make sure you have added everything needed for a show or movie.

Git and GitHub Resources

Credits

πŸ’–Check out a list of all of the EmojiScreen contributors.

Emoji graphics are by Twitter and are licensed under CC-BY 4.0. Review the Attribution Requirements for more information.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

emojiscreen's People

Contributors

azt3risk avatar beamed8 avatar bianavic avatar brittanyrw avatar gideon-lanex avatar ibrahimcaj avatar isalevine avatar jerilmj avatar lmaffeo avatar matheuscr30 avatar matinicusrock avatar mrillusion avatar navneetsharmaui avatar nilerbarcelos avatar nitinnair89 avatar nungster avatar oliviale avatar pawelraciborski avatar prashi23 avatar rodolfobrian avatar shafran123 avatar stevechendc avatar sumanismcse avatar susanahan avatar tiaraju avatar venkatramanareddy avatar wilchrist avatar yogasakti avatar yvescabral avatar zesterquinn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

emojiscreen's Issues

Add a timed game mode

Add a game mode page where users will try to guess as many cards as they can within a specific time limit.

Required:

  • Need to add an input that would check the user guess against the emoji card title

Add all of the Avengers series movies and review existing Avengers cards

Make sure that all of the Avengers movies (just the ones titled Avengers, check the Issues for more Marvel movies) have been added to EmojiScreen and review the emojis in existing ones to make sure they make sense/are descriptive enough for people to guess when we have game mode created.

Organize CSS file

Organize the main.css file and add comments so that it is easy to tell what CSS goes with each section of the website.

Mobile styling updates

Make sure that the styling looks great on more screen sizes.
For example, here is a screenshot of iPhone 5:
Screen Shot 2019-07-17 at 11 42 00 PM

On all screens, the emojis should all fit on one line.

Organize the README - Show Examples Section

The README is very detailed but very long, let's break out some of the sections into their own markdown (md) files and link that file to the README.md file.

  • Create a new file named Examples.md.
  • Take the entire 'Movie, TV Show and Musical Examples' section and add it to the new file.
  • In the README, add a link to the Examples.md you have created in place of the previous walkthrough section. Also include a sentence explaining what the link is for.
  • Bonus: (optional) Add additional resources to help people find a movie, TV or musical to add to the list.

Here is a resource for links in Markdown: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links
Here is resource for linking Markdown files to each other: https://github.blog/2013-01-31-relative-links-in-markup-files/

Reorganize the app file structure so that all shows/movies are not in one JSON file

Right now, all of the data is pulling from one file data.json. As more items are added, this could end up being a very large file. Should think about ways to break out the data into multiple files.

Changing this could also help with avoiding conflicts.

Some ideas:

  • Create folders for movies, tv and musicals. Inside each folder have a JSON file.

Screen Shot 2019-07-18 at 9 39 18 AM

  • Create folders for movies, tv and musicals. Inside each folder, have each individual show be a separate file.

Screen Shot 2019-07-18 at 9 40 33 AM

Organize the README - Resources Section

The README is very detailed but very long, let's break out some of the sections into their own markdown (md) files and link that file to the README.md file.

  • Create a new file named Resources.md.
  • Take the entire 'Resources & Opinions' section and add it to the new file.
  • In the README, add a link to the Resources.md you have created in place of the previous walkthrough section. Also include a sentence explaining what the link is for.
  • Bonus: (optional) Add additional Git and Github resources to this file.

Here is a resource for links in Markdown: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links
Here is resource for linking Markdown files to each other: https://github.blog/2013-01-31-relative-links-in-markup-files/

Add a quiz game mode

Add a game mode where users will try to guess emoji cards within a certain number. Such as how many can they guess out of 20.

Add difficulty for each card in data.json

For game mode, we should allow for users to chose various difficulty levels.
Inside of the data.json file, we need to add a new item to each object called difficulty, which should be a string.

See example:

{
 "title":"A Star is Born",
 "emojiImgs":"πŸŽ€πŸ‘©πŸ‘¨πŸŽΈβ­",
 "genres":[
  "action",
  "comedy",
  "musical"
 ],
 "type":"movie",
 "year":1994,
 "difficulty": "medium"
}

Come up with a criteria for difficulty. It could be, if there are 4 or more emojis, it is easy. If there are three it is medium and if there are one or two it is hard. Or it could be some other criteria. Feel free to run it by me here in the issue before you update code if you would like.

Add difficulty to the current items in the data.json file based on your criteria once that is figured out. And then add a section in the README under Card Overview that explains what difficulty is and what the criteria is.

Organize the README - Walkthrough Section

The README is very detailed but very long, let's break out some of the sections into their own markdown (md) files and link that file to the README.md file.

  • Create a new file named Walkthrough.md.
  • Take the entire 'Walkthrough' section and add it to the new file.
  • In the README, add a link to the Walkthrough.md you have created in place of the previous walkthrough section. Also include a sentence explaining what the link is for.

Here is a resource for links in Markdown: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links
Here is resource for linking Markdown files to each other: https://github.blog/2013-01-31-relative-links-in-markup-files/

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.