Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/iturres/template-vite-react-js

Project Template with: React + JavaScript + SCSS / CSS3 + ESLint(js,jsx) + StyleLint
https://github.com/iturres/template-vite-react-js

css3 project-template reactts scss typescript web-application web-development

Last synced: 25 days ago
JSON representation

Project Template with: React + JavaScript + SCSS / CSS3 + ESLint(js,jsx) + StyleLint

Host: GitHub
URL: https://github.com/iturres/template-vite-react-js
Owner: ITurres
License: mit
Created: 2024-02-24T23:51:46.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-03-10T02:17:26.000Z (10 months ago)
Last Synced: 2024-12-06T07:54:09.587Z (28 days ago)
Topics: css3, project-template, reactts, scss, typescript, web-application, web-development
Language: JavaScript
Homepage:
Size: 130 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


    

    Vite: React + JavaScript + SCSS or CSS3



> This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules + Airbnb style guide.

❗ Please choose between `SCSS` or `CSS3` and remove the other from the project.

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh

- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

**Additional non-vite default dependencies:**

- "prop-types": "^15.8.1".

- "react-icons": "^4.11.0".

- "react-router-dom": "^6.15.0".

**Additional non-vite default dev-dependencies:**

- "eslint-config-airbnb": "^19.0.4".

- "eslint-plugin-react": "^7.33.2".

- "eslint-plugin-react-hooks": "^4.6.0".

- "eslint-plugin-react-refresh": "^0.4.5".

- "sass": "^1.66.1".

- "stylelint": "^13.13.1".

- "stylelint-config-standard": "^21.0.0".

- "stylelint-csstree-validator": "^1.9.0".

- "stylelint-scss": "^3.21.0".

---

  📂 Ideal File/Folder Structure



---

## Documentation Template





    

    [PROJECT_NAME]



---

# 📗 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)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

---

# 📖 [PROJECT_NAME] | Book a Ride App 

**[PROJECT_NAME]** .

> Project description.

---

## Learning objectives

- Learning objectives.

(back to top)


---

## 🛠 Built With 

### Tech Stack 

  


    

      

      React.js

    

    

      

      JavaScript

    

    

      

      SCSS

    

    

      

      CSS3

    

    

      

      HTML

    

  


---

---

### Key Features 

- **Feature 1:** Description of feature 1.

(back to top)


---

## 🚀 Live Demo 

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

### Setup

Clone this repository to your desired folder:

Example commands:

- With SSH:

```bash

  cd my-folder

  git clone SSH-KEY-HERE

```

- With HTTPS:

```bash

  cd my-folder

  git clone HTTPS-LINK-HERE

```

- With GitHub CLI:

```bash

  cd my-folder

  gh repo clone GITHUB-USERNAME/REPO-NAME

```

### Install

Install this project's dependencies with:

```bash

  npm install

```

### Usage

To run the project, execute the following command:

```bash

 npm run dev

```

Runs the app in the development mode.\

Open [http://localhost:5173](http://localhost:5173) to view it in your browser.

The page will reload when you make changes.\

You may also see any lint errors in the console.

### Run Linters

#### > ESLint

```bash

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

```

#### > Stylelint

```bash

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

```

(back to top)


---

## 👥 Authors 

👤 **Arthur Iturres**

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

- LinkedIn: [Arthur Emanuel G. Iturres](https://www.linkedin.com/in/arturoemanuelguerraiturres/)

- Angellist / Wellfound: [Arturo (Arthur) Emanuel Guerra Iturres](https://wellfound.com/u/arturo-arthur-emanuel-guerra-iturres)

- Youtube: [Arturo Emanuel Guerra Iturres - Youtube Channel](https://www.youtube.com/channel/UC6GFUFHOtBS9mOuI8EJ6q4g)

- Portfolio: [Arthur Iturres - Portfolio](https://iturres.github.io/iturres-reactive-portfolio/)

(back to top)


---

## 🔭 Future Features 

- [ ] **Feature 1:** Description of feature 1.

(back to top)


---

## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page]().

(back to top)


---

## 🙌 Show your support 

Give a ⭐ if you liked this project!

(back to top)


---

## 🙏 Acknowledgments 

- Acknowledgments.

(back to top)


---

## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)


---