Skip to content

A platform that combines features of five great libraries into one platform. (WIP)

Notifications You must be signed in to change notification settings

CliffCrerar/nextjs-materialize-css-app

Repository files navigation

MATERIAL NEXT (coming soon)

A platform from which to strap great looking UI web apps using Nextjs, Material-CSS, Markdown and bootstrap 4 util classes to reduce the amount of CSS a developer has to write.

With a build in dynamic theming mechanism build your app but only decide on the best color scheme, while you are developing test out different color schemes.

Also build the color schemes to be dynamic at run time.


About

The tooling docs are still under construction but feel free to try out the application and suggest improvements. if you are familiar with Next.js you will find it easy. if you do not know Next.js please visit the link below. Next.js is easy to learn provided you also already know React.


Boiler ingredients

  1. Next.js
  2. React
  3. Materialize CSS
  4. Bootstrap4 Utility Classes

Theming

The project comes with 3 standard themes:

  1. default ( Material UI theme )
  2. blue-deeporange
  3. indigo-blue
  4. pink-indigo

TODO

  1. Some content on the features page.
  2. Footer
  3. Data retrieval makeshift setup
  4. Explain the dedicated
  5. Explain Default components
  6. Explain Static Data
  7. Explain now config
  8. Explain services
  9. Split and refactor features page
  10. Explain Changing fonts
  11. Explain Markdown in react
  12. Nextjs links to docs, links to other docs where required in JS files
  13. Explain plugin and environment configuration.
  14. Hookup blank style files style.css and style.scss
  15. Fix navbar react component name 'BavBarBrand'
  16. Remove MDX plugin
  17. Explain creating new themes
  18. Implement mailing list
  19. Implement hotkeys
  20. Explain layouts

HOW TO RUN

Create directory where you want to clone;

Clone this URL: https://github.com/CliffCrerar/nextjs-materialize-css-app.git

Run npm install in cloned directory.

Run npm run devSite builds the dev app in a new or existing .next directory.


Running production build

To create a production build run the following commands:

npm run build creates as dist directory with the production version. (see below section on how to configure.)


Build directory default config

Look inside the next.config.js for the 2 variables productionBuildDirectory and developmentBuildDirectory these are as their names suggest, the settings for the directories where the app will be built.

For development it is set to the Next.js default standard .next directory. Out of the box the app will create a dist directory on the project root when you run npm run build .

If you change these default settings remember to also update these in the .gitignore if you are planning on deploying to Zeit .

TODO

Configuring the node path


CSS, SASS or Styled JSX

This has comes out of the box with all 3 of the above, no additional configuration required. It already uses a mix of the 3, you may obviously apply your own discretion as yo which one you prefer.


License

MIT License

Copyright (c) 2019 Infinity Arc

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.

About

A platform that combines features of five great libraries into one platform. (WIP)

Resources

Stars

Watchers

Forks

Packages

No packages published