nataliapoletaeva / javascript-capstone-kanban

This is a project that is made to show my skills in JavaScript. It's a capstone for the second module of Microverse curriculum.

MicroTheatre

The JavaScript capstone project is about building our own web application based on an external API TV Maze API. We selected an API that retrieves TV shows and show various data about the shows. The webapp has 2 user interfaces and user can like and comment on each show.

🏗️ Built With

• HTML
• CSS
• JavaScript
• Webpack
• API

🖇️ LiveLink

• Live demo here

🛫 Getting Started

To get a local copy up and running, follow the steps in Setup below.

Prerequisites

Basic knowledge of HTML, CSS, and JavaScript.

Setup

If you installed git you can clone the code to your machine, or download a ZIP of all the files directly. Download the ZIP from this location, or run the following git command to clone the files to your machine:

git clone https://github.com/NataliaPoletaeva/Javascript-Capstone-Kanban.git

• Once the files are on your machine, open the Javascript-Capstone-Kanban folder in Visual Studio Code, and follow the steps in Installation & Set Up

🛠 Installation & Set Up

1. Install Node Modules

   npm install

2. Start the development server

   npm start

3. Open http://localhost:8080 to view it in the browser.

🚀 Building and Running for Production

1. Generate a full static production build

   npm run build

🧪 Running Tests with Jest

1. Start the development server

   npm run test

💉 Install

The following tools help make easier to work with sample code.

• git: A tool for managing source code
• Visual Studio Code: A source code editor
• NVM

👨🏾‍💻👩🏻‍💻 Authors

👤 Tshephang Mampa

• GitHub: tmampa
• LinkedIn: Tshephang Mampa
• Twitter: Tshephangm_

👤 Natalia Poletaeva

• Twitter: @Fly_Meets
• LinkedIn: Natalia Poletaeva
• GitHub: NataliaPoletaeva

🤝 Contributing

Contributions, issues, and feature requests are welcome!

❤️ Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Thank you for Microverse for providing the required materials

📝 License

This project is MIT licensed.

javascript-capstone-kanban's Issues

[3pt] - Add tests for items counter - Student A

Make sure that function for the items counter is covered with unit tests using Jest.

[0.5pt] Add footer - group task

Create footer according to the wireframe:

[0.5pt] Find external API - group task

Find an API to base the development of the webapp around it. The API should allow you to

• Get a list of items with a unique item id (or generate the unique id).
• For a given item, get detailed information about it.
  choose an APIs that doesn't need authentication. if you select an API that requires authentication, you should implement it on your own. Also, if you select an API that provides image resources your webapp will be more visual.

[3pt] - Add tests for comments counter - Student B

Make sure that function for the comments counter is covered with unit tests using Jest.

[3pt] - Create feature: add new like - Student A

When the user clicks on the Like button of an item (on Homepage), the interaction is recorded in the Involvement API and the screen is updated.

[4pt] - Display list of items on the Homepage - Student A

Create the main part of the homepage that keeps the layout from the wireframe:

When the page loads, the webapp retrieves data from the selected API and shows the list of items on screen with the basic data (e.g. title + image).

Prepare also "Comments" and "Reservations" buttons. They should be doing nothing - just being displayed.

This task does not include displaying the number of likes for each item.

This task does not include the counter of the items.

[4pt] -Display Comments pop up with selected item's details - Student B

Create a comments popup only with the top section (displaying details of the selected item)

When the popup loads, the webapp retrieves data from the selected API and shows details about the selected item.

Add event to button prepared by your teammate that will open your popup. You need to communicate with your team member to make sure that you do not block each other (most likely the easiest solution is to merge the list of items feature to the dev branch before you try to add that event).

[4pt] - Display number of likes for each item on the Homepage - Student A

When the page loads, the webapp the Involvement API to show the item likes and combines them with the data from the base API.

Remember that your page should make only 2 requests:

• one to the base API
• and one to the Involvement API.

This task does not include displaying the likes button (heart icon on the wireframe) for each item.

[3pt] - Display comments for a given item on the Comments pop-up - Student B

When the popup loads, the webapp retrieves data from the Involvement API to show the item comments.

This task does not include the counter of the comments.

[3pt] - Add comments counter - Student B

Even if the API gives you the number of comments you will create a specific function to calculate it.

Make sure that the correct number is displayed on the Comments pop up.

[0.5pt] Set up the project with Webpack and Jest- group task

• Set up Gitflow
• Set up webpack
• Set up a JavaScript testing library (Jest)

Set up Kanban board

In this milestone we have set up the Kanban board:

• Link to the project
• Number of members in the group: 2

[4pt] - Create feature: add new comment - Student B

Implement the "add new comment" form on the Comments pop up according to the wireframe:

When the user clicks on the "Comment" button, the data is recorded in the Involvement API and the screen is updated.

[1pt] Choose assets - group task

Choose images, text, icons, fonts.

Morning peer-peer code review

That's really great job you have done. Nothing is stopping you from asking for external review

To Highlight:

• You have added a descriptive Readme file. Good Job. ✔️
• There is no linter error present. ✔️
• Great modulization of your codebase ✔️
• Good variable naming conventions ✔️
• Project has met all the technical aspects you needed for this project. Keep rocking! ✔️

Cheers and Happy coding!👏👏👏

[0.5pt] Add header - group task

Create page header according to the wireframe:

[3pt] - Add all items counter on the Homepage - Student A

Even if the API gives you the number of items, you will create a specific function to calculate it.

Make sure that the correct number is displayed on the Homepgae.