https://github.com/textbook/starter-kit

Starter kit for full-stack JavaScript projects
https://github.com/textbook/starter-kit

cloud-foundry eslint express heroku javascript playwright react supertest typescript vite

Last synced: 4 days ago
JSON representation

Starter kit for full-stack JavaScript projects

• Host: GitHub
• URL: https://github.com/textbook/starter-kit
• Owner: textbook
• License: isc
• Created: 2019-05-31T18:19:44.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T09:01:51.000Z (4 months ago)
• Last Synced: 2024-09-18T03:56:02.611Z (4 months ago)
• Topics: cloud-foundry, eslint, express, heroku, javascript, playwright, react, supertest, typescript, vite
• Language: JavaScript
• Homepage:
• Size: 18 MB
• Stars: 38
• Watchers: 3
• Forks: 73
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Starter Kit v2

- [x] [Node] LTS support (verified working on 20.x LTS release)

- [x] [Express] server

- [x] [Postgres] database with [`pg`][node-postgres]

- [x] Logging with [Winston] and [Morgan]

- [x] [React] client with [Vite]

- [x] Client-side routing with [React Router]

- [x] Linting with [ESLint] and [Prettier]

- [x] Unit and integration testing with [Vitest] (with [SuperTest] and [TestContainers])

- [x] E2E testing with [Playwright]

- [x] Dev mode (watch modes for client and server, proxy to avoid CORS issues)

- [x] Production build (single deployment artifact)

- [x] [GitHub Actions] pipeline

- [x] [Google App Engine], [Heroku], [Render] or [Vercel] deployment

- [x] [Docker] build

## Scripts

Various scripts are provided in the package file, but many are helpers for other scripts; here are the ones you'll

commonly use:

- `dev`: starts the frontend and backend in dev mode, with file watching (note that the backend runs on port 3100, and the frontend is proxied to it).

- `e2e`: builds and starts the app in production mode and runs the Playwright tests against it.

  - `e2e:dev`: builds and starts the app in dev mode and runs the Playwright tests against it.

- `lint`: runs ESLint and Prettier against all the relevant files in the project.

- `serve`: builds and starts the app in production mode locally.

- `ship`: runs `lint`, then `test`, then `e2e`; ideal before a `git push`.

- `test`: runs the unit and integration tests.

  - `test:cover`: runs the tests and outputs coverage data.

[Docker]: https://www.docker.com

[ESLint]: https://eslint.org/

[Express]: https://expressjs.com/

[GitHub Actions]: https://github.com/features/actions

[Google App Engine]: https://cloud.google.com/appengine/?hl=en

[Heroku]: https://www.heroku.com/

[Morgan]: https://github.com/expressjs/morgan

[Node]: https://nodejs.org/en/

[node-postgres]: https://node-postgres.com/

[node-test]: https://nodejs.org/api/test.html

[Playwright]: https://playwright.dev/

[Postgres]: https://www.postgresql.org/

[Prettier]: https://prettier.io/

[React]: https://reactjs.org/

[React Router]: https://reactrouter.com/en/main

[Render]: https://render.com/

[SuperTest]: https://github.com/visionmedia/supertest

[TestContainers]: https://testcontainers.com/

[Vercel]: https://vercel.com/

[Vite]: https://vitejs.dev/

[Vitest]: https://vitest.dev/

[wiki]: https://github.com/textbook/starter-kit/wiki

[Winston]: https://github.com/winstonjs/winston