This project uses Sass, a CSS preprocessor that allows the use of variables, nesting, mixins, inheritance, and other interesting features that make writing CSS more powerful and flexible.
The project follows the 7-1 architecture of Sass, which is a structure to organize Sass files into seven folders and one main file. This structure helps keep the code organized and makes project maintenance easier.
After installation, you will have the option to view various components in your browser and see how the architecture is used in a frontend application with ReactJS and NextJS.
Provides an architecture option with Sass and practical application in NextJS for community developers. See the Demo.
- Established NextJS architecture
- Established 7-1 Sass architecture
- Component examples
- Examples of global styling of tags and components with Sass
- Eslint configuration
- Prettier configuration
- Jest and Coverage configuration
- Husky configuration
- Commitlint configuration
- Pre-commit pipeline with Prettier and Eslint
- Commit-msg pipeline with Commitlint
- CI/CD with workflow on Github Actions with linter check, prettier check.
- Automated versioning semantic-release - to be developed
- Node.js
- npm
- Docker
Clone the repository to your local machine and install the dependencies:
git clone git@github.com:rwmsousa/boilerplate-next-sass.git
cd boilerplate-next-sass
yarnTo build the project, run the following command:
make buildmake runAccess: http://localhost:3000
For more information on the different aspects of the project, see the following READMEs:
Contributions are always welcome! If you have an improvement or correction, feel free to fork the repository and submit a pull request. If you have any questions or suggestions, you can open an issue.
Copyright (c) 2023 - Ricardo Sousa
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.