https://github.com/ab-noori/react-template

A project template with ready README file for creating react applications.
https://github.com/ab-noori/react-template

code-review github-issues issues mit-license project-template pull-requests react-project readme readme-template template

Last synced: 25 days ago
JSON representation

A project template with ready README file for creating react applications.

• Host: GitHub
• URL: https://github.com/ab-noori/react-template
• Owner: ab-noori
• License: mit
• Created: 2023-05-31T15:51:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-22T07:34:05.000Z (over 1 year ago)
• Last Synced: 2024-11-10T03:03:37.402Z (3 months ago)
• Topics: code-review, github-issues, issues, mit-license, project-template, pull-requests, react-project, readme, readme-template, template
• Homepage:
• Size: 406 KB
• Stars: 17
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


![](https://img.shields.io/badge/Microverse-blueviolet)





> # Template

| Desktop Veiw Representation|

|---------------------------------------|

|
|

|
|

|
|


# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 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)

# 📖 [Template] 

> **[Temaplate]** is a project template with ready README file for creating react applications.  

## 🛠 Built With 

### Tech Stack 

- Client

    


      
HTML

      
CSS

      
JavaScript

      
ReactJS

      
API

    


### Key Features 

- **[Responsive layout]**

- **[UX/UI accessibility]**

- **[Dynamic data]**

(back to top)


## 🚀 Live Demo 

> - [Live Demo on Gh-pages](https://ab-noori.github.io/math-magicians/)

> - [Live Demo on Render](https://math-magicians-ab.onrender.com)

(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 [email protected]:ab-noori/template.git

### Install

- Install this project with:

       npx create-react-app my-app

       cd my-app

       npm start

### Usage

- Use following commands to run on your local system:

      npm run build

      npm run deploy

### Run tests

- Run the following script and style test:

      npx eslint "**/*.{js,jsx}"

      npx eslint "**/*.{js,jsx}" --fix

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

      npx stylelint "**/*.{css,scss}" --fix

 

### Deployment

- 1- install `'gh-pages'` with following command:

      npm i -D gh-pages

- 2- Add `'homepage'` to project's jason file:

      "homepage": "https://ab-noori.github.io/repo-name",

- 3- Add the following scripts to project's jason file:

      "predeploy": "npm run build",

      "deploy": "gh-pages -d build "

- 4- Finally run the following command:

      npm run deploy

(back to top)


## 👥 Authors 

👤 **Abdul Ali Noori**

- GitHub: [@ab-noori](https://github.com/ab-noori)

- Twitter: [@AbdulAliNoori4](https://twitter.com/AbdulAliNoori4)

- LinkedIn: [abdul-ali-noori](https://www.linkedin.com/in/abdul-ali-noori-384b85195/)

## 🔭 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](https://github.com/ab-noori/.../issues).

(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. Also I want to give credit to [`Nerd's lesson`](https://www.youtube.com/@Nerdslesson)

YouTub Channel, it's [`react tutorial`](https://www.youtube.com/watch?v=cd3P3yXyx30) is really helpfull.

(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](./LICENSE) licensed.

(back to top)