JS-Capstone-Project

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

JS-Capstone-Project

★ 15 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 📗 Table of Contents

- [📖 About the Project](#about-project)
  - [🛠 Built With](#built-with)
    - [Video Walkthrough](#video-walkthrough)
    - [Tech Stack](#tech-stack)
    - [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
  - [Setup](#setup)
  - [Prerequisites](#prerequisites)
  - [Install](#install)
  - [Usage](#usage)
  - [Run tests](#run-tests)
  - [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 JS-Capstone Project <a name="about-project"></a>

**JS-Capstone Project** is a JavaScript project at microverse

## 🛠 Built With <a name="built-with">Webpack, HTML, CSS, Java Script & Jest</a>

### Tech Stack <a name="tech-stack"></a>

### [Find the Video Walkthrough here.](https://drive.google.com/file/d/1TEzzApjrGHLBD-sQHCjF9gYdAxjF4epn/view?usp=sharing) <a name="Video-walkthrough"></a>

> Webpack HTML CSS, Java Script(ES6), Jest

<details>
 <summary>Client</summary>
 <ul>
 <li><a href="https://webpack.js.org/">WEBPACK</a></li>
 <li><a href="https://developer.mozilla.org/en-US/docs/Web/HTML">HTML</a></li>
 <li><a href="https://developer.mozilla.org/en-US/docs/Web/CSS">CSS</a></li>
 <li><a href="https://jestjs.io/docs/getting-started">Jest</a></li>
 </ul>
</details>

### Key Features <a name="key-features"></a>

- **Project setup with webpack**

(<a href="#readme-top">back to top</a>)

## 💻 Getting Started <a name="getting-started"></a>

Try to have these in your local machine

- Git and GitHub
- VS Code or any code editor

### Prerequisites

In order to run this project you need 
- A web browser
- Code editor

### Setup

Clone this repository to your desired folder:

git clone https://github.com/kalbek/JS-Capstone-Project

### Install

Install this project using the cloned repo or download and use the files to your local machine.

### Usage

- Clone the repository first
- Commnads to Run: 
    - npm install
    - npm run build
    - npm start

### Run tests

- tests are included using Jest framework
- commands to run:   npm run test

### Deployment

You can deploy this project through Github Pages

(<a href="#readme-top">back to top</a>)

## 👥 Authors <a name="authors"></a>

👤 **Kaleb Bekele**

- GitHub: [@githubhandle](https://github.com/kalbek)
- Twitter: [@twitterhandle](https://twitter.com/KNuramo)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/kaleb-nuramo/)
- Website: https://kalbek.github.io/Portfolio/

## 👥 Authors <a name="authors"></a>

👤 **Naledi Dikgale**

- GitHub: [@githubhandle](https://github.com/Naledi-Dikgale)
- Twitter: [@twitterhandle](https://twitter.com/ChichiTheStar)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/naledi-dikgale-068423159/)
- Website: https://naledi-dikgale.github.io/mobile-portfolio/

(<a href="#readme-top">back to top</a>)

## 🔭 Future Features <a name="future-features"></a>

- [ ] **Changes will be made as comming project requirement.**

(<a href="#readme-top">back to top</a>)

## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(<a href="#readme-top">back to top</a>)

## ⭐️ Show your support <a name="support"></a>

If you like this project give a star to this repositiory.

(<a href="#readme-top">back to top</a>)

## 🙏 Acknowledgments <a name="acknowledgements"></a>

- I would also like to thank Microverse for the guidance they made all the way up to this point.

(<a href="#readme-top">back to top</a>)

## ❓ FAQ <a name="faq"></a>

- **Is it allowed to copy the contents of this project and use it for personal use?**

- This project is free for copying and reusing in any way you like.

## 📝 License <a name="license"></a>

This project is [MIT](./MIT.md) licensed.

(<a href="#readme-top">back to top</a>)

JS-Capstone-Project

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README