Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Add features etc.

Tried to align with: https://github.com/will-molloy/java-template
  • Loading branch information
will-molloy committed Jun 23, 2024
1 parent d6df3c8 commit 5a18a61
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,42 @@

template repo for React projects

## Features

- React + Typescript + [Vite](https://vitejs.dev/)
- [pnpm](https://pnpm.io/)
- [GitHub Actions](https://github.com/features/actions) CICD, with deployment to [GitHub Pages](https://pages.github.com/)
- Code linting/formatting via [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/)
- Test support via [Jest](https://jestjs.io/) and [React Testing Library](https://testing-library.com/react)
- Code coverage reporting via [Codecov](https://codecov.io/)
- Dependency upgrades via [Renovate bot](https://renovatebot.com)

## Usage

- Go to: https://github.com/will-molloy/react-template/generate
- This will prompt you to create a new repository with all the files setup
- Click [Use this template](https://github.com/will-molloy/react-template/generate)
- This will prompt you to create a new repo with all the files setup
- Rename the project (currently `react-template`) to your liking
- Configure GitHub Pages to point at the `gh-pages` branch
- Create your README
- Delete anything you won't use
- Update the README
- Other non-code setup like your GitHub branch protections
- **NOTE:** if creating a private repo, you probably want to disable the windows and mac builds

### Install dependencies and start

```
```bash
pnpm install
pnpm dev
```

### Format code

```
```bash
pnpm lint --fix
```

### Deploy

**TBD**

```
npm run deploy
```
The site will be available at: `https://{username}.github.io/{repo-name}/`

0 comments on commit 5a18a61

Please sign in to comment.