# @7sne/project-setup

> My setup

Latest version **1.0.0** (published 2023-01-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @7sne/project-setup
pnpm add @7sne/project-setup
yarn add @7sne/project-setup
bun add @7sne/project-setup
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-01-12 |
| First published | 2023-01-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 22 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | 7sne |
| Maintainers | 7sne |
| Keywords | minimal, typescript, setup |

## Links

- npm: https://www.npmjs.com/package/@7sne/project-setup
- Repository: https://github.com/7sne/7sne-project-setup
- Homepage: https://github.com/7sne/7sne-project-setup#readme
- Issues: https://github.com/7sne/7sne-project-setup/issues
- npm.io page: https://npm.io/package/@7sne/project-setup

## Dependencies (3)

- [eslint-scope](https://npm.io/package/eslint-scope.md) ^5.1.1
- [eslint-utils](https://npm.io/package/eslint-utils.md) ^1.4.3
- [eslint-visitor-keys](https://npm.io/package/eslint-visitor-keys.md) ^1.3.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-01-12

## README

> 📢 NOTE: If your goal is to simply learn and play with TypeScript, which is what this repo was created to facilitate, **just use [Deno](https://deno.land/)** 🦕. Deno is a new JavaScript runtime that supports TypeScript out of the box, ships as a single executable, has built-in support for linting, formatting and testing, and offers even more!

# Minimal TypeScript project setup for curious minds

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This repository contains a simple setup for Node.js project with TypeScript. Feel free to take a look around the source code and step-by-step commit history, clone and fork the repo to try it out, and [open Issues](https://github.com/bobaekang/minimal-typescript-setup/issues) to share your suggestions for improvements.

Please refer to [this blog post](https://bobaekang.com/blog/minimal-typescript-project-setup-for-curious-minds/) for a detailed explanation.

## Project setup

```shell
git clone https://github.com/bobaekang/minimal-typescript-setup.git
cd minimal-typescript-setup

npm install
```

## Project structure

```
/
/dist   <- compiled JavaScript code goes here
/src    <- TypeScript source code lives here
/test   <- test files (**.test.ts) live     here
```

## Main dependencies

* [TypeScript](https://www.typescriptlang.org/)
* [`ts-node`](https://github.com/TypeStrong/ts-node) for development server
* [ESLint](https://eslint.org/) for linting
* [`typescript-eslint`](https://github.com/typescript-eslint/typescript-eslint) for ESLint plugins to support TypeScript
* [Prettier](https://prettier.io/) for formatting source code
* [Mocha](https://mochajs.org/) for testing

## npm scripts

npm script | description
--- | ---
`build` | Compile TypeScript source code to JavaScript
`lint` | Typecheck, lint and format TypeScript source code
`serve` | Run TypeScript source code directly with `ts-node`
`start` | Run compiled JavaScript code
`test` | Run tests with Mocha

## License

[MIT](./LICENSE)

---
_Source: https://npm.io/package/@7sne/project-setup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._