https://github.com/sebyx07/venus-cra-react

https://github.com/sebyx07/venus-cra-react

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sebyx07/venus-cra-react
• Owner: sebyx07
• Created: 2024-03-12T14:40:58.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-03-18T17:13:30.000Z (10 months ago)
• Last Synced: 2024-11-07T17:14:49.744Z (2 months ago)
• Language: JavaScript
• Size: 312 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


 Create-React-App Boilerplate 2022 





    







        



        

        

        

        





Purpose


This project is designed as a simple to use template that can launch a website at any time to GitHub pages.


By using this template, you can instantly launch a simple SPA (single page application) to GitHub pages and share it with friends.


A future repository will be created where I'll include a backend service. Currently the scope of this template is limited to frontend only - Ideal for blog pages, information websites, or if you've already got a backend deployed elsewhere.


Note: I've followed best practices as closely as possible whilst still providing users with the ability to tweak or remove any one part without the entire project collapsing.



Technologies


| Name             |   Purpose   | Optional (Y/N) |

| :--------------- | :---------: | :------------: |

| GitHub Actions   |    CI/CD    |       Y        |

| Create-React-App | Quick Start |       Y        |

| Jest + Codecov   |   Testing   |       Y        |

| GitHub Pages     |   Hosting   |       Y        |

| Codefactor       |   Quality   |       Y        |

| Sass             |   Styling   |       Y        |

Note: You can convert this project to Typescript, please see here

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).



GitHub Actions


Commits to master branch


- Deploys a production build to gh-pages branch using GitHub actions

- Code is tested and coverage reports uploaded to codecov

Pull Request to Master


- Standard test suite runs against code

- Eslint checks code and comments on the Pull Request if a problem exists



Create React App


This project has not been ejected. You can do so if you wish.

Commands:


- Start development server `npm run start`

- Run test suite `npm run test`

- Create production build `npm run build`

- Lint code `npm run lint`

- Create lint report `npm run lint:report`