Skip to content

A ReactJs template designed for a design studio called Studio Zed. Feel free to contribute or use this for your own needs.

Notifications You must be signed in to change notification settings

OudomMunint/StudioZed-ReactJS

Repository files navigation

A Studio Zed project made with React Js
Feel free to use it as a template for your own projects!
Visit Studio Zed!

PRs Welcome


👋🏻 Report Bug    

Maintenance:

maintenance-status

Deploy status:

Netlify Status CodeQL PROD Build + Release

Tech Stack

This project was built using these technologies.

  • React
  • NodeJS
  • Jest
  • Netlify
  • ESLint
  • Bootstrap
  • Webpack
  • CSS3
  • HTML5

Getting Started

  • Install Node Js and Git globally on ur machine.
  • Clone, download or fork this repository.
  • Open the project with your IDE, use "Open Folder method"
  • Delete all files that have a ".lock" as file extension.
  • Open a terminal inside your IDE workspace.
  • CD into the project's directory.
  • Run npm install.
  • Run npm start.

Running an optimized build

  • Run npm install.
  • Run npm run build to create an optimized build.
  • Run install -g serve to install serve globally.
  • Run serve -s build to serve the optimized build.
  • From the terminal, you can see the local address & network address to view the build, copy and paste it in your browser.

Running tests

  • Run npm run test to run tests.
  • There are 1 test suite and 5 tests in total.
  • Testing setup can be found in setupTests.js & all tests are in App.test.js.
  • Tests are written using Jest & React Testing Library.
  • All 5 Tests are currently integrated into the CI/CD pipeline.
  • Example of test output:
  PASS  src/App.test.js
  √ Test home page content (525 ms)
  √ Find contact form (156 ms)                                                                
  √ Find form submit button (38 ms)                                                            
  √ Test web vitals (2 ms)                                                                 
  √ Test AboutPage (30 ms)                                                                      

Test Suites: 1 passed, 1 total                                                                   
Tests:       5 passed, 5 total                                                               
Snapshots:   0 total
Time:        4.137 s

Forms

  • The implementation of the contact form is integrated with Netlify forms.
  • Learn how to set up Netlify forms here.

Known Issues

  • Security issues found in dependencies but are low risk to this project, See dependabot alert #26, alert #12.

About

A ReactJs template designed for a design studio called Studio Zed. Feel free to contribute or use this for your own needs.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published