Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/tailwind react location #4

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Prev Previous commit
Next Next commit
Fix readme
  • Loading branch information
nejcrogelsek committed Jun 10, 2022
commit 616a6ab51905704f178e564c4eff59c20a881be6
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -7,7 +7,29 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo
`git clone https://github.com/nejcrogelsek/react-project-template.git`
2. Delete .git file inside cloned project.
3. Run: `yarn run start:clean`
4. Run: `yarn run husky:postinstall` to install husky git hook (automatically formats the code when pushing code to github)
4. Initialize git & run: `yarn run husky:postinstall` to install husky git hook (automatically formats the code when pushing code to github)

**With react-location instead of react-router-dom:**
1. Clone project by running:
`git clone https://github.com/nejcrogelsek/react-project-template.git`
2. Fetch the react-location branch:
`git fetch origin feature/react-location`
3. Checkout into react-location branch:
`git checkout feature/react-location`
4. Delete .git file inside project.
5. Run: `yarn run start:clean`
6. Initialize git & run: `yarn run husky:postinstall` to install husky git hook (automatically formats the code when pushing code to github)

**With tailwindCSS & react-location:**
1. Clone project by running:
`git clone https://github.com/nejcrogelsek/react-project-template.git`
2. Fetch the tailwind react-location branch:
`git fetch origin feature/tailwind-react-location`
3. Checkout into react-location branch:
`git checkout feature/tailwind-react-location`
4. Delete .git file inside project.
5. Run: `yarn run start:clean`
6. Initialize git & run: `yarn run husky:postinstall` to install husky git hook (automatically formats the code when pushing code to github)

## Available Scripts

2 changes: 1 addition & 1 deletion src/pages/Home/Home.tsx
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@ import Icon from 'components/shared/Icon/Icon'
const Home: FC = () => {
return (
<div className="home">
<h1 className="text-red">Home component</h1>
<h1>Home component</h1>
<Link to="/login"> Go to Login</Link>
<Icon icon="close" />
<Icon icon="logo" />