-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
110 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| ## GIF App | ||
| > GIF search app that helps users search their favorite gifs | ||
| <div align="center"> | ||
| <!-- Badges --> | ||
| <p> | ||
| <a href="https://github.com/Louis3797/awesome-readme-template/graphs/contributors"> | ||
| <img src="https://img.shields.io/github/contributors/el634dev/movie-tracker" alt="contributors" /> | ||
| </a> | ||
| <a href=""> | ||
| <img src="https://img.shields.io/github/last-commit/el634dev/movie-tracker" alt="last update" /> | ||
| </a> | ||
| <a href="https://github.com/Louis3797/awesome-readme-template/issues/"> | ||
| <img src="https://img.shields.io/github/issues/el634dev/movie-tracker" alt="open issues" /> | ||
| </a> | ||
| <a href="https://github.com/Louis3797/awesome-readme-template/blob/master/LICENSE"> | ||
| <img src="https://img.shields.io/badge/Made%20with-JavaScript-1f425f.svg" alt="made with javascript" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| <h4> | ||
| <a>View Demo</a> | ||
| <span> · </span> | ||
| <a href="https://github.com/el634dev/gif-search/README.md">Documentation</a> | ||
| </h4> | ||
| </div> | ||
|
|
||
| <br /> | ||
|
|
||
| <!-- Table of Contents --> | ||
| ## Table of Contents | ||
| - [Screenshot](#screenshot) | ||
| * [Tech Stack](#tech-stack) | ||
| * [Features](#features) | ||
| * [Environment Variables](#environment-variables) | ||
| - [Getting Started](#getting-started) | ||
| * [Prerequisites](#prerequisites) | ||
| * [Installation](#installation) | ||
| * [Run Locally](#run-locally) | ||
|
|
||
| <!-- About the Project --> | ||
| ## Screenshot | ||
| <div align="center"> | ||
| <img width="1047" alt="Screenshot 2024-03-03 at 7 22 49 PM" src="https://github.com/el634dev/movie-tracker/assets/84924260/882216a4-e56c-4d74-b646-4e285ad840a7"> | ||
| </div> | ||
|
|
||
| <!-- TechStack --> | ||
| ## Tech Stack | ||
| <details> | ||
| <summary>Client</summary> | ||
| <ul> | ||
| <li><a href="https://handlebarsjs.com/">Handlebars</a></li> | ||
| <li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li> | ||
| </ul> | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Server</summary> | ||
| <ul> | ||
| <li><a href="https://nodejs.org/en">Node</a></li> | ||
| <li><a href="https://expressjs.com/">Express</a></li> | ||
| </ul> | ||
| </details> | ||
|
|
||
| <!-- Env Variables --> | ||
| ## Environment Variables | ||
| To run this project, you will need to add the following environment variables to your .env file before running `python app.py` | ||
|
|
||
| `APP_KEY` - set this as your Tenor API Key | ||
|
|
||
| <!-- Getting Started --> | ||
| ## Getting Started | ||
|
|
||
| <!-- Prerequisites --> | ||
| ### Prerequisites | ||
| This project uses npm as package manager which comes pre-installed with Node | ||
|
|
||
| <!-- Installation --> | ||
| ### Installation | ||
|
|
||
| <!-- Run Locally --> | ||
| ### Run Locally | ||
| Clone the project using | ||
|
|
||
| ```bash | ||
| git clone | ||
| ``` | ||
|
|
||
| Go to the project directory | ||
|
|
||
| ```bash | ||
| cd gif-search-main | ||
| ``` | ||
|
|
||
| Install npm | ||
|
|
||
| ```bash | ||
| npm install | ||
| npm init | ||
| ``` | ||
|
|
||
| Start the server, can use nodemon but you must install it using `npm install nodemon -g` | ||
|
|
||
| ```bash | ||
| nodemon | ||
| ``` | ||
|
|
||
| <!-- Project Status --> | ||
| ## Project Status | ||
| Project is: __completed__ |