https://github.com/ariym/base-ts
Typescript boilerplate and template.
https://github.com/ariym/base-ts
Last synced: 8 months ago
JSON representation
Typescript boilerplate and template.
- Host: GitHub
- URL: https://github.com/ariym/base-ts
- Owner: ariym
- Created: 2024-12-26T19:18:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-10T15:56:47.000Z (over 1 year ago)
- Last Synced: 2025-02-10T16:46:50.903Z (over 1 year ago)
- Language: TypeScript
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# base-ts
Starter boilerplate for typescript projects.
1. Clone
```bash
git clone https://github.com/ariym/base-ts
```
2. Download dependencies
```bash
npm i
```
## Advanced Setup
### `npm run build` on a dir other than /src
[pkgroll instructions for using dir other than /src](https://github.com/privatenumber/pkgroll?tab=readme-ov-file#entry-points) are to add `--src=dirname` flag to pkgroll command in the package.json scripts
### Enviroment Variables
> As of **Node v20.6** added .env file support deprecating the need for dotenv.
1. In order to use a .env file first ensure that at least one exists. (.env, .env.development, .env.production)
1. Then add this to the package.json dev/prod scripts `--env-file=.env` *after* the `node` or `tsx` word respectively.
## TODO
- [ ] replace `npm run setup` with with setup.js that uses cli to ask about setting up .env, .env.production, etc.