https://github.com/ernestomedinam/hello-react-alternative

reactJS + vite open boilerplate
https://github.com/ernestomedinam/hello-react-alternative

reactjs-boilerplate vite vitest

Last synced: about 1 month ago
JSON representation

reactJS + vite open boilerplate

• Host: GitHub
• URL: https://github.com/ernestomedinam/hello-react-alternative
• Owner: ernestomedinam
• License: mit
• Created: 2024-05-13T15:56:31.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-07T21:19:36.000Z (8 months ago)
• Last Synced: 2025-02-17T14:48:29.234Z (4 months ago)
• Topics: reactjs-boilerplate, vite, vitest
• Language: JavaScript
• Homepage:
• Size: 216 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hello react + vite! 🤓

lightly opinionated base template for reactJS project with use case examples for routing & complex state management; built for 4GeeksAcademy community & open for all.

## how to use 😎

- install project dependencies based on boilerplate's lock file with `$npm clean-install`

- build `.env` file based on `.env.example` and update variable values

- start dev server with `$npm run start`

- test with `$npm run test`

- lint with `$npm run lint`

- code away

- build with `$npm run build`

> need to add new code for a feature? first thing is to build tests based on desired user experience for such feature

> need a new component or page? build them in folders inside src/components or src/pages

> need a new route? modify Layout.jsx

> need another context? replicate MainContext folder

> need more actions for the same context but the file is too big? split actions based on concerns and build hooks for them (i.e. useConcernActions)

## pending 🤪

- add loader component and add where it makes sense for user experience

- refactor based on module/feature folder structure, instead of file type folder structure

- update reactTs analogue

## notes 📝

> built with Node v20.9.0

> note: this is not official 4GeeksAcademy content but I'd be really glad for it to be considered as such, so in spirit it kind of is 😅

> note: this boilerplate is open for you to use as you please on your personal projects, but please DO NOT use this boilerplate for your 4Geeks final project nor any of 4Geeks program projects, as your TA's will reject them and I will be reprimanded 😐

made with ♥ by mentors @4GeeksAcademy.