This is a template for creating Typescript projects
MIT License
This is a template for creating Typescript projects.
This template will help you start a Typescript project without needing to worry about any configuration.
In the project directory, you can run:
yarn
or npm i
Installs every dependency needed for the project.
yarn start
or npm start
Runs the app in the development mode. The app will reload every time you save a file.
You will also see any lint errors/warnings in the console.
yarn dev
andnpm run dev
do the same.
yarn prod
or npm run prod
Runs the app in the production mode.
Before running the app, it will run the linter, format code with Prettier, and build the project.
yarn build
or npm run build
Builds the app for production to the build
folder.
Your app is ready to be deployed!
yarn prod
andnpm run prod
do the same, and also run the app after building it.
yarn lint
or npm run lint
Runs the linter and logs every error and warning to the console.
yarn lint:fix
andnpm run lint:fix
fix every autofixable error/warning.
yarn prettier
or npm run prettier
Runs Prettier and logs every error and warning to the console.
yarn prettier:fix
andnpm run prettier:fix
fix every autofixable error/warning.
yarn check
or npm run check
Runs both the linter and Prettier and logs every error and warning to the console.
yarn check:fix
andnpm run check:fix
fix every autofixable error/warning.
You can use Docker to run your app. This project has a multi-stage build process so your final image doesn't have any TypeScript files nor dev dependencies, resulting in a smaller image size.
To build your image run: docker build -t <image-name> .
To run your image run: docker run -p 80:80 <image-name>
If you haven't used Docker before, you can get started with it here.
Contributions are more than welcome!
We think that you might have great ideas to make this project even better. If you do, please create a pull request and/or issue following the contribution guidelines.
Give a ⭐️ if this project helped you!
Copyright © 2022 Toti Muñoz. This project is MIT licensed.
This project was made with ❤ and TypeScript