Skip to content

ab-noori/react-project-template

Repository files navigation

React Project Template

Desktop Veiw Representation
screenshot

📗 Table of Contents

📖 [React-Project-Template]

[React-Project-Template] is an environmental setup and tools needed to develop a React application.

🛠 Built With

Tech Stack

Key Features

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

(back to top)

🚀 Live Demo

(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 git@github.com:ab-noori/react-project-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

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

🔭 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)

About

Environmental setup and tools needed to develop a React application.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published