Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Authors
6. Support
7. 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:

• Enter this url: https://github.com/osbentech/kanban-board-setup/ in your web browser.
• Clone it to your local machine.
• Once the download is complete you will be able 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

1. First, Initialize NPM Package Manageer

npm init -y

2. 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

3. 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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Authors

👤 Debby Miressa

• GitHub: @debby_miressa
• Twitter: @debby_miressa
• LinkedIn: LinkedIn

👤 Benjamin Ejike

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

Acknowledgments

• Hat tip to 👤 TVMaze (Providing the Base API we consumed in our project)
  • API: @TVMaze_API
• Inspired by TVMaze

support

Give a ⭐️ if you like this project!

License

This project is MIT 📝 licensed.