- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ
- 📝 License
Series Guide Application is a small application that displays some of the popular shows in the world. It also allows users to share their comments and feedback about their favored shows and give a thumbs up thanks to the external Involvement and TVMaze API services.
- HTML
- SCSS
- Javascript
- Webpack
- Display shows
- Display popup containing show's details
- Give feedback and thumbs up to your favorite show
To get a local copy up and running, follow these steps.
In order to run this project you need to install these prerequisites:
- If you're running on Windows you can download the prerequisites from the links down below:
-
If you're running on Linux follow these steps down below:
-
Install git.
sudo apt install git
- Install nodejs and npm.
sudo apt install nodejs
Clone this repository to your desired folder:
git clone git@github.com:Kweeka1/movies-app.git
cd movies-app
Install this project with:
npm install
To run the project, follow below instructions:
- Take a unique id from the involvement api:
curl -X POST https://us-central1-involvement-api.cloudfunctions.net/capstoneApi/apps/
-H 'Content-Type: application/json'
- Create a new file in root directory called
.env
and insert below code:
INVOLVEMENT_KEY={KEY_YOU_GOT_FROM_CURL_COMMAND}
- Example
INVOLVEMENT_KEY=0onO2DYOtlOD4dJgAQd1
- Now you can run the app by executing:
npm run start
To run tests, run the following command:
npm run test
You can deploy this project using npm library called gh-pages
:
- First install the library
npm install gh-pages --save-dev
- Then follow the instructions provided in their readme file to deploy the app
👤 Mohamed Talbi
- GitHub: Mohamed Talbi
👤 Sammy Ndabo
- GitHub: Sammy Ndabo
- Add loading skeleton to show item cards
- Add a search bar to search for a specific show
- Add category links in the header section
- Load progressively show's comments
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!
I would like to thank Microverse for project inspiration.
-
What version of nodejs does this project works on?
- The project runs well with nodejs 14+. you might face some issues while running this project in lower versions.
This project is MIT licensed.