TVmaze-shows-website
TVmaze-shows-website copied to clipboard
🎥 TVMaze is a website where you can see top shows related info, like them, and add comments. Team @ITurres, @Ruthmy. Check it out! 👇
![tv-maze-logo](https://github.com/ITurres/TVmaze-shows-website/raw/dev/src/assets/media/tvm-header-logo-red.png)
Movies Website
📗 Table of Contents
-
📖 About the Project
-
🛠 Built With
- Tech Stack
- Key Features
- 🚀 Live Demo
-
🛠 Built With
-
💻 Getting Started
- Setup
- Prerequisites
- Install
- Usage
- Run tests
- Deployment
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- 📝 License
🎥 TV Maze website
"TV Maze" capstone project is about building a SPA web application based on an external API. We had selected an API that provides data about a topic that we liked and then we built the webapp around it. The webapp have 2 user interfaces.
Learning objectives:
- Use JavaScript to make websites dynamic and build basic single page apps.
- Use ES6 syntax.
- Use ES6 modules.
- Use callbacks and promises.
- Use webpack.
- Apply JavaScript best practices and language style guides in code.
- Use AAA pattern for unit tests.
- Write units tests for a JavaScript app.
- Follow Gitflow.
- Solve simple git conflicts.
- Send and receive data from an API.
- Use API documentation.
- Understand and use JSON.
- Make JavaScript code asynchronous.
- Perform a code review for a team member.
🛠 Built With
Tech Stack
Key Features
- HTML & CSS3
- JavaScript
- Linters
- Lihgthouse
- StyleLint
- ESLint
- Webpack 5
- Follow Microverse's list of best practices for JavaScript projects.
(back to top)
🚀 Live Demo
(back to top)
💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
A modern browser (supports html5)
Git and a GitHub account
Setup
Clone this repository to your desired folder by using this 👇️ command :
git clone https://github.com/ITurres/TVmaze-movies-website.git
Install
Install this project with:
npm install
Usage
npm run start
Run tests
npm test
Deployment
- Not aplicable.
(back to top)
👥 Authors
👤 Arthur Iturres
- GitHub: @ITurres
- Twitter: @Arthur_ITurres
- LinkedIn: Arthur Emanuel G. Iturres
👤 Ruth Abreu
(back to top)
🔭 Future Features
- [ ] Migrate to React TypeScript.
(back to top)
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
(back to top)
⭐️ Show your support
If you like this project and know someone who might find it helpful, please share it. Or give it a star ⭐️
(back to top)
🙏 Acknowledgments
I thank Microverse for this fantastic opportunity, the code reviewers for their advice and time, and my excellent coding partner and team member @Ruthmy 🏆
(back to top)
📝 License
This project is MIT licensed.
(back to top)