Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 5.11 KB

local_dev_walkthrough.md

File metadata and controls

54 lines (38 loc) · 5.11 KB
Raw

Local Development

This is a walkthrough of how to add an Emoji Card to this project.

This method will use your local machine to contribute to the project. This will require you to download multiple programs onto your computer. This is the method most programmers use when working on projects.

Required Downloads & Tools

  • Terminal (Mac OS) or Command Prompt. This is a program installed by default on your computer. Search for the program to open it. For Windows, you can also use Git Bash. The terminal is a text interface where you can run commands on your computer (think about those black screens you see in hacker movies).
  • Git - This is a version control tool. It helps you track changes in your files and is what we will use to send the code from your computer to Github. For Windows, this download will include Git Bash.
  • A text editor such as Sublime Text, Atom, Visual Studio Code, etc. This program will be used to write the actual code for your contribution.

Local Development Instructions

  1. Fork this repository using the Fork button at the top right of this Github repository (also known as repo). This will create a copy of the repository for your Github account.
  2. Once the repo is forked, you will be taken to the forked repo. Again, this is a copy of the project on your account. Note: In the top left, the name of the repo should now include your username.
  3. Download the project to your computer. You must do this for the repository in your account NOT the main EmojiScreen repository. Click on the Clone button. Copy the HTTPS github repo link.
  4. In your terminal, navigate to where you would like to save the project (such as cd Desktop). Run the following command in the terminal, replacing the following link with your copied link: git clone https://github.com/your-username-will-be-here/emojiscreen.git;
  5. After the command has been run, in the terminal, navigate into the EmojiScreen project folder: cd emojiscreen.
  6. Open the emojiscreen project in your text editor of choice. Edit the movies.js, tv.js, or musicals.js file and add a new object for your movie, TV show or musical in alphabetical order. Make sure there is a comma between your object and the objects above and below. Refer to the card overview section for requirements for the different object keys. Make sure to save your file after you have made changes.

Use the following object as a template:

{
  title: "The Lion King",
  emojiImgs: "🦁👑🌍",
  genres: ["animation", "adventure", "drama"],
  itemLink: "https://www.imdb.com/title/tt0110357/",
  type: "movie",
  year: 1994
}
  1. If you would like to see what your addition will look like, open the index.html file that is in the emojiscreen folder in a web browser. The EmojiCards are added in a random order so it may take you a few seconds to find what you added. If you do not see any cards in the browser, this could mean that you have a typo in your movies.js, tv.js, or musicals.js file. If that is the case, double check what you have added for missing commas and quotation marks.
  2. Once you are done, go to the terminal and type git status. You should see movies.js, tv.js, or musicals.js as modified. If you don't see this, go back and make sure to save your file.
  3. Run git add -A to add your changes.
  4. Add a commit message. Run the following command and replace with your movie or show name: git commit -m "Added Harry Potter the movie".
  5. If you have never used git on your computer before, you will see a message asking for you to set your email and username. If you do not see that message, continue to the next step. Run the following commands, replacing "[email protected]" with your Github email and "Your name" with your github username:

git config --global user.email "[email protected]"

git config --global user.name "Your Name"

Then re-run the commit command. Remember to replace with your show or movie: git commit -m "Added Harry Potter the movie"

  1. Run git push. If you have not done this before, git push will not run you give access to your GitHub account. You can find instructions in the GitHub docs.

  2. Go to the Github website and navigate to the Pull Request tab. Click on New Pull Request.

Screenshot of a Pull Request on the Github website

  1. Review your changes and then click Create Pull Request. Review the Pull Request checklist to check that you have completed everything for your Emoji Card. Then click on Create Pull Request.
  2. Wait for feedback/review of your Pull Request. Your code will be reviewed and if any changes need to be made, we will let you know. Once your pull request is accepted, you will be able to see your card at https://emojiscreen.com and you will officially have contributed to the project! 🎉