Skip to content

Commit 0ee9628

Browse files
committed
feat: library starter
1 parent a4b35b9 commit 0ee9628

24 files changed

+2995
-21622
lines changed

.github/workflows/tests.yml

+1-21
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,4 @@ jobs:
1818
run: npm install
1919

2020
- name: Test
21-
run: npx jest --config=jest.config.js
22-
e2e:
23-
runs-on: ubuntu-latest
24-
25-
steps:
26-
- uses: actions/checkout@v3
27-
28-
- uses: actions/setup-node@v3
29-
with:
30-
node-version: 16
31-
cache: 'npm'
32-
33-
- name: Install Dependencies
34-
run: npm install
35-
36-
- name: Cypress run
37-
uses: cypress-io/github-action@v4
38-
with:
39-
build: npm run build
40-
start: npm run start
41-
wait-on: "http://localhost:3000"
21+
run: npx jest --config=jest.config.cjs

Makefile

+1-5
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ deps:
99
compile:
1010
npm run build
1111

12-
.PHONY: start
13-
start:
14-
npm start
15-
1612
.PHONY: test
1713
test:
1814
npm test
@@ -23,4 +19,4 @@ lint:
2319

2420
.PHONY: lint-fix
2521
lint-fix:
26-
npm run lint:fix
22+
npm run lint:fix

README.md

+2-10
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
</p>
66

77
<h1 align="center">
8-
<⚡⚛️> Vite React Best Practices Template (by Codely)
8+
<⚡⚛️> Vite React Library Template (by Codely)
99
</h1>
1010

1111
<p align="center">
@@ -15,7 +15,7 @@
1515
</p>
1616

1717
<p align="center">
18-
Template for creating React apps with TypeScript following best practices: Unit and end-to-end tests, Continuous Integration, and linting.
18+
Template for creating React libraries with TypeScript following best practices: Unit tests, Continuous Integration, and linting.
1919
<br />
2020
<br />
2121
<a href="https://github.com/CodelyTV/vite-react_best_practices-template/stargazers">Stars are welcome 😊</a>
@@ -48,13 +48,6 @@
4848

4949
`npm run test`: Run unit tests with Jest and React Testing Library
5050

51-
### End-to-end tests
52-
53-
1. `npm start`: Start the development server on [localhost:3000](http://localhost:3000)
54-
2. Run end-to-end tests with Cypress choosing one of the following options:
55-
- `npm run cy:open`: Open Cypress in dev mode
56-
- `npm run cy:run`: Execute Cypress in CLI
57-
5851
## 🔦 Linting
5952

6053
- `npm run lint`: Run linter
@@ -65,7 +58,6 @@
6558
- [TypeScript](https://www.typescriptlang.org)
6659
- [ESLint](https://eslint.org) and [Prettier](https://prettier.io) already configured with the [🤏 Codely's configuration](https://github.com/CodelyTV/eslint-config-codely)
6760
- [Jest](https://jestjs.io) with [React Testing Library](https://testing-library.com/docs/react-testing-library/intro) for the unit tests
68-
- [Cypress](https://www.cypress.io) with [Testing Library](https://testing-library.com/docs/cypress-testing-library) for the end-to-end tests
6961
- [GitHub Action Workflows](https://github.com/features/actions) set up to run tests and linting on push
7062
- [Makefile](https://github.com/CodelyTV/vite-react_best_practices-template/blob/main/Makefile) for standardize how to run projects
7163
- [Sass](https://sass-lang.com) to supercharge CSS with nested classes and more fun

cypress.config.ts

-14
This file was deleted.

0 commit comments

Comments
 (0)