ts-simple-starter
v2.2.5
Published
A simple starter for TypeScript projects
Downloads
18
Maintainers
Readme
TS Simple Starter
A simple CLI to start your TS project with minimal configuration.
Basic configuration includes:
- TS
- Eslint + Prettier
- Jest
- Path Aliases
- Choose the template you want
For now we have 3 templates:
- Pure TS
- Express with TS
- Complete Express (Express, Prisma, Docker, Docker Compose, Postgres, JWT + Auth Flow)
Get Started Immediately
You don't need to install or configure tools like TS version, ESlint, Prettier and Path aliases. They are preconfigured and you can change anything you want (TS version, ESlint version, anything).
Just run the command, and you're good to go.
Quick Overview
npx ts-simple-starter my-app
cd my-app
npm run dev
Running tests in the project folder
npm run test
Path aliases
You can simple import everything that is inside src/
or tests/
just using import anything from '@/any-folder'
or import tests from '@/tests/any-folder'
How to contribute
- Fork the project
- Clone your forked repo locally
- Create a new branch in your own forked repo with a brief name like
feat/feature-name
npm run install
to install the packages- Make changes in the
index.js
file, that's the main entrypoint - If you want to create a new template, create under the root folder, just like
template/
- Add the new template to the
index.js
entrypoint ->getTemplatePathFromAnswers()
function - Run
node . my-app
to run the entrypoint with the new code you just wrote - Create the PR from your fork to the main repo