Table of Contents
-
About The Project
-
Getting Started
- Usage
- Contributing
- Authors
- Support
- License
JavaScript Capstone Project
The JS Capstone website is a JavaScript project which uses webpack and ES6 features, notably modules. Developed from wireframe and consumes the TVMaze API and Involvement API using JavaScript async and await.
(back to top)
Preview 📸
Built With
- HTML, CSS, Javascript
- Bootstrap
- Github
- Webpack
- Gitflow
(back to top)
Live Demo
- Click here to get started with a live demo
Presentation Link
- Click here to see our presentation of the project.
Getting Started
Instructions on how to access my project locally:
Prerequisites
If you need to run my project locally follow the steps below :
- Have git installed. (For version control)
- Have text editor installed. (Preferablly VSCode)
- Have node installed.
- Have npm package manager Installed.
- Have webpack installed. (module bundler)
- Have CSS,HTML & JS Linters installed and configured. For further information, visit this link to get better understanding on each linters used on this project.
- Properly use ES6 Syntax and ES6 Modules throughout the project.
Installation
- First, Initialize NPM Package Manageer
npm init -y
- Install Webpack, Required plugin(s), Style/CSS Loader and Webpack-dev-server
npm install webpack webpack-cli --save-dev
npm install --save-dev html-webpack-plugin
npm install --save-dev style-loader css-loader
npm install --save-dev webpack-dev-server
- Start running build
npm build run
npm start
(back to top)
Usage
This will be updated when the project is finished.
(back to top)
Contributing
Contributions 🤝 are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a ⭐️! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
)
- Commit your Changes (
git commit -m 'Add some AmazingFeature'
)
- Push to the Branch (
git push origin feature/AmazingFeature
)
- Open a Pull Request
(back to top)
Authors
👤 Debby Miressa
👤 Benjamin Ejike
Acknowledgments
- Hat tip to 👤 TVMaze (Providing the Base API we consumed in our project)
- Inspired by TVMaze
support
Give a ⭐️ if you like this project!
License
This project is MIT 📝 licensed.