https://github.com/geisonjr/typescript-template
TypeScript Template
https://github.com/geisonjr/typescript-template
Last synced: 12 months ago
JSON representation
TypeScript Template
- Host: GitHub
- URL: https://github.com/geisonjr/typescript-template
- Owner: GeisonJr
- License: mit
- Created: 2024-03-19T23:42:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T23:52:21.000Z (almost 2 years ago)
- Last Synced: 2025-03-20T16:02:53.026Z (12 months ago)
- Language: TypeScript
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TypeScript Template
A template for TypeScript projects.
[](https://github.com/GeisonJr/typescript-template/blob/main/LICENSE)
> [!WARNING]
> This project is under development and is not yet ready for use.
## 🌱 Overview
This project is a template for TypeScript projects. It has a set of tools and configurations to help you start a new project.
## ✨ Features
- [x] CD with GitHub Actions
- [x] CI with GitHub Actions
- [x] EditorConfig
- [x] Prettier
- [x] Tests
- [x] TypeScript
## 🚀 Tecnologies
The following tools were used in the construction of the project:
- [EditorConfig](https://editorconfig.org/)
- [GitHub Actions](https://docs.github.com/en/actions)
- [Jest](https://jestjs.io/)
- [Node.js](https://nodejs.org/en/)
- [Prettier](https://prettier.io/)
- [TypeScript](https://www.typescriptlang.org/)
## 📦 Get Started
First, clone the project:
```bash
git clone https://github.com@geisonjr/typescript-template.git
```
Then, access the project directory:
```bash
mv typescript-template
cd
```
Install the dependencies using the package manager [npm](https://docs.npmjs.com/) to install the dependencies.
```bash
npm install
```
## 📝 GitHub
### Create a new repository on the command line
```bash
git init
git add README.md
git commit -m "first commit"
git branch -M main
git remote add origin git@github.com:/.git
git push -u origin main
```
### Push an existing repository from the command line
```bash
git remote add origin git@github.com:/.git
git branch -M main
git push -u origin main
```
## 📋 License
This project is under the
[MIT License](https://github.com/geisonjr/typefy/blob/master/LICENSE)