This repo shows the development state of the website built at claritydetailingsolutions.com.
Despite being available on github, this repository is intended as a read-only resource and has been licensed as such. Permissions are not given to use or modify this software.
This section is intended for usage of future developers or upon permissional changes.
After cloning the repo to your local machine enter the root directory and run npm install
.
Then, run npm build
.
Having completed this, in the root directory run npm start
.
This runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Explained here are the most important points of the code structure, where to find configs, etc.
.
├── frontend
│ ├── public # Static assets that are deployed as-is when built
│ ├── src # Code directory for frontend container
│ │ ├── assets # Static assets (images, icons)
│ │ ├── components # Non-page level react components (ex. navbar)
│ │ ├── pages # React component pages (ex. about, contact)
│ │ ├── styles # Global styles and SCSS mixins
│ │ ├── utils # Reusable functions and globals
│ │ ├── App.jsx # Main app file composing the entire application
│ │ ├── AppRouter.jsx # Router file that controls website path direction and redirection
│ │ └── ...
│ ├── .gitignore # Files that should not be posted to git (ex. npm modules)
│ ├── jsconfig.json # Project config (enables absolute path imports)
│ ├── package.json # Frontend code dependencies
│ └── ...
├── .eslintrc # Airbnb Eslint configs/rules
├── .prettierrc # Prettier configs/rules
└── ...
Frontend:
Linting and Formatting:
The Clarity Detailing Solutions website is hosted via the Netlify platform. On commits to the master branch, Netlify automatically deploys the updated branch to production.
As this code is currently unlicensed, no permissions are given to use or modify this software.