🧚🏻‍♀️✨ TypeScript ✨🧚🏻‍♀️🦄🔮🏰💕

A TypeScript project template that contains minimalistic boilerplate for any project. It uses swc for compilation, typescript for type checking and is preconfigured with eslint, prettier, jest and docker. You likely don't want to use everything exactly the way it is, but it'll get you set up quickly. The rest is up to you.

🧚🏻‍♀️✨ Status 🌈☁️

🧚🏻‍♀️✨ Repository 📚🚀

🧚🏻‍♀️✨ Project 📚🎨

🧚🏻‍♀️✨ Requirements 🗝️🔒

🪄✨ git 💯
🪄✨ nvm 💯
🪄✨ node >= 18 💯
🪄✨ npm >= 8 💯
🪄✨ docker 🤷🏻‍♀️
🪄✨ docker compose 🤷🏻‍♀️

🧚🏻‍♀️✨ Setup 🚧🚀

You can either use the bin script or you can set it up manually.

🧚🏻‍♀️✨ Script

🪄✨ npx @matriarx/typescript init

🧚🏻‍♀️✨ Manual

🪄✨ git clone https://github.com/matriarx/typescript.git
🪄✨ mv typescript <project>
🪄✨ cd <project>
🪄✨ cp .env.example .env
🪄✨ nvm use 18
🪄✨ npm install

🧚🏻‍♀️✨ Usage ✨🦄

🪄✨ npm start ~ Start lib/index.js.
🪄✨ npm run compile ~ Compile the source code using typescript.
🪄✨ npm run build ~ Create a production build using @swc/core.
🪄✨ npm run dev ~ Compile in watch mode to recompile on file changes.
🪄✨ npm run review ~ Statically analyze the codebase using typescript.
🪄✨ npm run lint ~ Lint the codebase using eslint.
🪄✨ npm run style ~ Style and format the codebase using prettier.
🪄✨ npm run test ~ Run the tests using jest.
🪄✨ npm run qa ~ Run review, lint, style and test.
🪄✨ npm run type ~ Generate types using typescript.
🪄✨ npm run compose ~ Start a docker container for development.
🪄✨ npm run recompose ~ Rebuild the docker container.
🪄✨ npm run release ~ Create a docker release image.
🪄✨ npm run deploy ~ Start a docker container using the release image.
🪄✨ npm run clean ~ Clean up the project, remove all temporary files and the cache.
🪄✨ npm run prune ~ Prune all docker containers, images, volumes and the builder cache.
🪄✨ npm run prepare ~ Automatically run on npm install to add husky hooks to git for lint-staged.

🧚🏻‍♀️✨ Documentation 📚🔮

🪄✨ Project
🪄✨ Discussions
🪄✨ Issues
🪄✨ Wiki
🪄✨ Docs
🪄✨ Code of Conduct
🪄✨ Contributing
🪄✨ Security
🪄✨ Changelog
🪄✨ Release Notes
🪄✨ Authors
🪄✨ Contributors
🪄✨ Acknowledgements
🪄✨ Supporters
🪄✨ Contact
🪄✨ License

🧚🏻‍♀️✨ Collaboration ✨💕

Thank you to the authors who created this project, the contributors who collaborated, the supporters who help make it possible, as well as notable acknowledgements.

🧚🏻‍♀️✨ Contributors 💎🚀

🧚🏻‍♀️✨ License 🔮✨