Capstone Group Porject

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run Linters
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 A Capstone Group Project with Webpack

A Capstone Group Porject developed with webpack, gitflow, githubflow and the best combo of HTML, CSS and JAVASCRIPT. In addition, we added Linters for Html, Css and Javascript.

🛠 Built With

1-HTML 2-CSS 3-JS

Tech Stack

Client

• HTML
• CSS
• JS
• webpack

Key Features

• Add index.html file.
• Add index.js file.
• Add index.css file.
• Add Linters.
• Add Webpack config.
• Add Item to homepage
• Add Likes and likes count
• Add comments pop, create comments, load comments and comments count
• Add Item counts to homepage
• Add Test for count function using jest

(back to top)

💻 Getting Started

Prerequisites

1-Web Browser 2-Code Editor 3-Git

Setup

Clone this repository to your desired folder:

Run this Command:

  cd my-folder
  git clone https://github.com/balatstar/code-joy-project.git

Install

First you need to install the node package files Run this command:

  cd code-joy-project
  npm install

Usage

• In order to use this project you either create branch to add more features.
• But in order to run the project run npm start
• Run npm run build when you're done.

Run Linters

I have added the linters or tests in order to avoid anykind of typos and ensure the good practices in this project. So while using this repository if you need to check your work in html and css you can use below commands

• in order to run the linter test on index.html:

 npx hint .

• in order to run the linter test on stylesheets:

 npx styleint "**/*.{css,scss}"

Deployment

• You can easily use github pages, netlify or vercel to deploy your project Useful link about Github Pages Step by Step guide to deploy using netlify Step by Step guide to deploy using vercel

(back to top)

👥 Authors

👤 Sodeeq Awoyemi

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

👤 Joyce Cruz

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

(back to top)

🔭 Future Features

• [ ] Add categories page
• [ ] Add about us page
• [ ] Add contact us page

(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 just give it a star -

(back to top)

🙏 Acknowledgments

I would like to thank Microverse.

(back to top)

📝 License

This project is MIT licensed.

(back to top)