ab-noori / Project-Template

A ready template with lintr files and README template added for starting a new project.

Template Repository

Desktop view shoots for this project:

Desktop Veiw Representation

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [your_project_name]

Describe your project in 1 or 2 sentences.

[your_project__name] is a...

🛠 Built With

Tech Stack

• Client
  • HTML
  • Bootstrap
  • JavaScript

Key Features

• [Responsive layout]
• [UX/UI accessibility]
• [Dynamic data]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

In order to run this project you need:

• A browser of you choice.
• A text editor of your choice.
• An installed node.js on your local system

Setup

Clone this repository to your desired folder:

• Use the following Commands:

  cd your-desired-folder
  git clone [e-mail]:ab-noori/Project-Template.git
  

Install

Install this project with:

• You can deploy this projec on hosting provider of your choise or you can deploy it on github pages.

Usage

• To add data the local storage of browser
• To read data from local storage of browser.
• To display data.
• To remove data from local storage.

Deployment

You can deploy this project using:

• Free deployment services like GitHub pages.
• Any deployment services of your choice.

(back to top)

👥 Authors

👤 Abdul Ali Noori

• GitHub: @ab-noori
• Twitter: @AbdulAliNoori4
• LinkedIn: abdul-ali-noori

👤 Samson Tush

• GitHub: @Samson

(back to top)

🔭 Future Features

• [Add About page]
• [Add Contact 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, give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and my coding partners, and also give credit to Traversy Media YouTub Channel, I really learned a lot from this channel.

(back to top)

❓ FAQ (OPTIONAL)

• How to make it mobile friendly?

  • Put a viewport tag in the header

• How to design the site?

  • Draw a mockup before start to code

(back to top)

📝 License

This project is MIT licensed.

(back to top)