Foot - Every project needs a foot to stand on

A boilerplate project and structure for a Node.js with TypesScript and all the trimming such as EsLint, Jest, Cypress, Prettier, etc.

Getting Started

Get a clone of this project named correctly using Degit (or just git clone it)

npx degit jordan112/foot#main my-new-node-app

Install all the dependencies

yarn

Build and start the project

yarn start

Or if you want one big super command line that does it all

npx degit jordan112/foot#main my-new-node-app && cd $_ && yarn && yarn start

Technologies all setup and configured and ready to go

1. Node.js
2. TypeScript
3. EsLint (with AirBnb defaults) - linting
4. Yarn
5. Yarn Workspaces (https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/)
6. Jest - Unit Testing framework
7. Cypress - Automated E2E testing
8. TypeDoc.org - for auto documentating
9. Prettier - consistent formatting
10. Husky - hooks for pre-commiting code to ensure linting and unit tests pass

Scripts

• yarn - install (and update minor versions) of all packages
• yarn start - Build and Start the project
• yarn build - build TypeScript project
• yarn test - run unit tests
• yarn test:watch - run unit tests while developing
• yarn test:coverage - run unit tests but also with code coverage
• yarn test:cypress - open cypress automated tests
• yarn test:cypress:run - run cypress automated tests (command line only)
• yarn lint - run esLint to lint project
• yarn lint:fix - run esLint and fix any issues
• yarn format:prettier - run Prettier to format project
• yarn format:prettier:fix - run Prettier to format project and auto correct
• yarn docs - generate docs using TypeDoc
• yarn release - Release a semantic version of the project

Update all of the dependencies

yarn upgrade