Skip to content

bomeskers/zmre

Repository files navigation

zmre

Zuurbier Meskers Real Estate rekentool

Installation

This repo uses Yarn for for package managing and developing.
Install all packages with the following command.

yarn install

This will run for a little while and install all dependencies you'll need to start working on the project.

Development

The project uses Webpack to bundle all files together in a single JS file, containing the JavaScript and CSS needed for the project. To start the engine and get to developing, execute the following command.

yarn start

This will start the watch program of Webpack, which means that every file you save will trigger a new build and refresh the files you're working with the latest changes.

Extensions

To make life a bit easier, but at the same time more complex, you'll need to use some extensions to accommodate for the usage of third party packages, like Tailwind CSS.

  • Prettier - For formatting your files according to specified rules. Look at the .prettierrc for the current configuration.
  • stylelint - A linter which will check your styles for any syntax mistakes. Also enables you to configure what the linter should look for or ignore.
  • Tailwind CSS IntelliSense - With this VSCode will know what certain features of Tailwind are and will give you hints about options that Tailwind offers.

Styles

Styling is done with the help of Tailwind.css. It's something like Bootstrap in that it has a lot of pre-defined classes that make it fast to work with, though Tailwind does not rely on Sass and has a lot of unique features.

I know this makes things a bit more complex, however, you're not required to actually use Tailwind and it's perfectly fine just to write your own CSS.

Do however use the module system. When creating a .css file it needs to be included in the build. Otherwise Webpack won't include the file when combining the files and the styles won't be applied.

For example, when creating a components/button.css file, include it by using a CSS @import statement in the style.css file including the button styles in the project.

@import './components/button';

Colors

I've looked for a color palette on coolors and landed on this set. I've picked this palette because I felt that it ambiates a calm, strong and professional energy and has enough room for creativity as the colors can be combined in many ways.

  • Merino | #F4F1DE
  • Terracotta | #E07A5F
  • Gun Powder | #3D405B
  • Acapulco | #81B29A
  • Manhattan | #F2CC8F

The color names are generated by a website with a name that color module. If this system is confusing, then we'll switch to regular names of colors, like red, blue, etc.

About

Zuurbier Meskers Real Estate rekentool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published