https://github.com/lucianopaci/typescript-starter
https://github.com/lucianopaci/typescript-starter
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lucianopaci/typescript-starter
- Owner: LucianoPaci
- License: mit
- Created: 2022-08-24T17:31:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-24T17:31:32.000Z (almost 3 years ago)
- Last Synced: 2025-01-17T03:33:01.100Z (4 months ago)
- Language: TypeScript
- Size: 131 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
**TEN stack** is a `Typescript` + `Express` + `Node` starter kit to develop `REST API` server apps.
Nothing new under the sun, just a straight forward combo to make server development a little bit faster. And of course, this make my freelancing days more enjoyable 😎
Comes with:
- Everything typed with [Typescript](https://www.typescriptlang.org/)
- [ES6](http://babeljs.io/learn-es2015/) features/modules
- ES7 [async](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) / [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
- Run with [Nodemon](https://nodemon.io/) for automatic reload & watch
- [ESLint](http://eslint.org/) for code linting
- Code formatting using [Prettier](https://www.npmjs.com/package/prettier)
- Configuration management using [dotenv](https://www.npmjs.com/package/dotenv)
- Improved commits with [Husky](https://typicode.github.io/husky)
- Manage production app proccess with [PM2](https://pm2.keymetrics.io/)
---
## Prerequisites
- [Node.js](https://nodejs.org) (`>= 12.0.0`)
- [Yarn](https://yarnpkg.com/en/docs/install) or [NPM](https://docs.npmjs.com/getting-started/installing-node)
## Install
- Fork or Use [this](https://github.com/filoscoder/tenstack-starter/generate) template repository.
- [Clone](https://github.com/git-guides/git-clone) the forked repository.
- Install the dependencies with [yarn](https://yarnpkg.com/getting-started/usage) or [npm](https://docs.npmjs.com/cli/v7/commands/npm-install).
> Make sure you already have [`node.js`](https://github.com/filoscoder/tenstack-starter#prerequisites) and [`npm`](https://github.com/filoscoder/tenstack-starter#prerequisites) or [`yarn`](https://github.com/filoscoder/tenstack-starter#prerequisites) installed in your system.
- Set your `git remote add origin` path
```bash
git remote add origin ${forked-and-cloned-path}
```
> [Update the url](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories#changing-a-remote-repositorys-url) if you already have an `origin`
## Config
- Copy `.env.example` a file at the root of the application.
- Add or modify specific variables and update it according to your need.
```bash
cp .env.example .env
```
> Check the `config` folder to customize your settings (`/src/config`)
## Alias @
To make paths clean and ease to access `@` is setup up for `/src` path
```javascript
// BEFORE
import config from './config';
import routes from './routes';
// NOW
import config from '@/config';
import routes from '@/routes';
```
> You can customize this setup:
> `/tsconfig.json` > compilerOptions.paths
> `/eslintrc.yml` > rules.settings.alias.map
## Local Development
Run the server locally. It will be run with Nodemon and ready to serve on port `8080` (unless you specify it on your `.env`)
```bash
yarn start # or npm start
```
> Check [`package.json`](https://github.com/filoscoder/tenstack-starter/blob/master/package.json) to see more "scripts"
## Production
First, build the application.
```bash
yarn build # or npm run build
```
Then, use [`pm2`](https://github.com/Unitech/pm2) to start the application as a service.
```bash
yarn service:start # or npm run service:start
```
# Contribution
This repository will be managed as an `open-source`.
Please feel free to open an `issue` or a `pull request` to suggest changes or additions.
# Support & Contact
If you have any question or suggestion, don't hesitate to contact me:
✉️ [[email protected]](mailto:[email protected])
🎧 I was listening [this](https://www.youtube.com/watch?v=_H8ku3APY40) playlist to boost my productivity!
# Author & Credits
