Skip to content

kathesama/starting-seed-react

Repository files navigation


IntellijIdea ReactJS React Router Redux MUI NPM
GitHub issues GitHub forks GitHub stars
GitHub last commit GitHub version commits GitHub top language
Maintaned

GitHub license GitHub repo size

Initial seed for a react project

Steps to run this project

  1. Clone this repo

    git clone https://github.com/kathesama/starting-seed-react.git

  2. Run install

    npm install

Then go to .git/hooks/commit-msg, find the main function and replace it:

const commitMsgFilePath = process.argv[2];

with:

const commitMsgFilePath = path.resolve(process.env.PWD, process.argv[2].substring(1));

-> This fixes Error: ENOENT: no such file or directory, open 'X:.git\COMMIT_EDITMSG'

Note: This project uses git-commit-msg-linter package, this one add a nice pattern for work in commit messages

correct format: <type>[scope]: <subject>

  type:
    feat     A new feature.
    docs     Documentation only changes.
    style    Changes that do not affect the meaning of the code
              (white-space, formatting, missing semi-colons, etc).
    refactor A code change that neither fixes a bug nor adds a feature.
    test     Adding missing tests or correcting existing ones.
    chore    Changes to the build process or auxiliary tools and
              libraries such as documentation generation.
    perf     A code change that improves performance.
    ci       Changes to your CI configuration files and scripts.
    build    Changes that affect the build system or external dependencies
              (example scopes: gulp, broccoli, npm).
    temp     Temporary commit that won't be included in your CHANGELOG.

  scope:
    Optional, can be anything specifying the scope of the commit change.
    For example $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc.
    In App Development, scope can be a page, a module or a component.

  subject:
    Brief summary of the change in present tense. Not capitalized. No period at the end.

Build container app and run it in Docker:

docker-compose -f ./docker-compose.yml build docker-compose -f ./docker-compose.yml up -d

Notes

  • This project has material UI installed