Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rileymanda/linter-config

Last synced: about 6 hours ago
JSON representation

Host: GitHub
URL: https://github.com/rileymanda/linter-config
Owner: RileyManda
Created: 2023-08-13T19:14:32.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-08-13T21:23:28.000Z (over 1 year ago)
Last Synced: 2023-08-13T21:24:44.022Z (over 1 year ago)
Size: 1.95 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        



  

  


  
React Workflows Config Template




# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

    

    

- [💻 Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 Attribution](#attribution)

- [📝 License](#license)

# 📖 Linter-Config 

React linters and workkflow starter template for React projects.

 

  

## 🛠 Built With 

### Tech Stack 

  eslint

  


    Eslint

  


  stylelint

  


    Stylelnt

  


  babel

  


    babel

  


## 🛠 Key Features 

### Features 

**eslint configs/presets*

**stylelint configs/presets*

**babel configs/presets*

**workflows**



(back to top)


 

(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:

### Setup

Clone this repository to your desired folder:

```sh

cd my-folder

git clone https://github.com/RileyManda/linter-config.git

```

### Install

Install this project with:

```sh

  cd my-project

  npm i

```

### Usage

To run the project, execute the following command:

```sh

  npm start

```

### Run tests

To run tests, run the following command:

```sh

  npm test

```

(back to top)


## 👥 Authors 

👤 **RileyManda**

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

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

- LinkedIn: [rileymanda](https://www.linkedin.com/in/rileymanda/)

(back to top)


## 🔭 Future Features 

**Feature1*

**Feature2*

**Feature3*

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/RileyManda/linter-config/issues).

(back to top)


## Show your support 🌟

Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:

 - Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

 - Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

 - Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)


## 🙏 Acknowledgments 

Gratitude goes to [Microverseinc](https://github.com/microverseinc) for the introductory material on React and Redux which inspired me to create and use of this [linter and git workflows setup](https://github.com/RileyManda/linter-config) based on this [template](https://github.com/microverseinc/linters-config/tree/master/react-redux) that i am using in this project and across all my other projects to ensure code quality and correct usage of syntax across css,jsx and js.

(back to top)


## ❓ FAQ 

- **Question_1**

  Do I have to use the vs code specifically?

  - Answer_1

    You can use any code editor of your choice. 


- **Question_2**

  Where can I download node JS for installation?

  - Answer_2

  Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.

  It can be downloaded [here](https://nodejs.org/en).

(back to top)


## 👥 Attribution 

- Original logo design template from: [Svgrepo](https://www.svgrepo.com/)

## 📝 License 

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)

(back to top)