https://github.com/rootstrap/node-ts-api-base-legacy
Base Project for NodeJs + TypeScript Backends
https://github.com/rootstrap/node-ts-api-base-legacy
Last synced: 29 days ago
JSON representation
Base Project for NodeJs + TypeScript Backends
- Host: GitHub
- URL: https://github.com/rootstrap/node-ts-api-base-legacy
- Owner: rootstrap
- License: mit
- Created: 2019-06-26T18:38:27.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T23:56:58.000Z (about 3 years ago)
- Last Synced: 2025-06-12T01:05:07.675Z (10 months ago)
- Language: TypeScript
- Size: 1.63 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
NodeJS & TypeScript Template
=========================================
## Overview
Node-TS is a base template created to help start new backend projects using NodeJS and TypeScript.
The main objective is helping new projects start feature development by providing a base architecture and basic services setup, using standard tooling and best practices.
## Architecture & Folder structure
The project is structured using a layered architecture, separating Persistence, Business logic and Routing. Specifically, Repositories, Services and Routers
Models are used to define your database entities and are passed through layers before. Then, serializers are in charge of exposing the correct data to the end user (so, at router level in this case).
The folder structure is [component-based](https://github.com/i0natan/nodebestpractices/blob/master/sections/projectstructre/breakintcomponents.md).
Assign a folder in your project root for each business component and make it self-contained - other components are allowed to consume its functionality only through its public interface or API (in this case, the `index.ts` file).
Apart from that, the following folders are present:
- `dist`: Stores all .js files built by the TypeScript compiler.
- `public`: Exposes publicly hosted files.
- `src`: Root folder for our codebase.
- `constants`: Constant definition such as status codes, enums, etc.
- `db`: Database related configurations and migration files.
- `models`: All entity models.
- `middlewares`: Express Middlewares.
- `utils`: Helpers such as loggers, date handling, etc.
- `tasks`: Used to store any standalone custom script that you would expose on your `package.json`
## Environment setup
- `Dotenv` is set up to manage environment variables locally, use the `.env.sample` file as a base and use one `.env` file per environment (so, development, test and production).
- `ormconfig` stores the base configuration for TypeORM.
## Scripts
The following scripts are provided as tooling to interact with the database, tests, builds, etc:
- `npm run lint`: Runs tslint with automatic fixes enabled.
- `npm run build`: Builds all files for release.
- `npm run dev`: Spins up the TS compiler and the backend concurrently for developing using hot reload.
- `npm run start`: Starts the backend (from the dist folder).
- `npm run db:sync`: Syncs the database, it **should not be used in production, since it can override data**.
- `npm run db:drop`: Drops the database
- `npm run db:migrate`: Runs migrations
- `npm run db:revert`: Revert latest executed migration
- `npm run db:logsync`: Compares the current db schema to see if new changes would need to be applied when running db:sync.
- `npm run typeorm:migration:generate -- -n migrationName`: Generates a new migration.
- `npm run typeorm:migration:create -- -n migrationName`: Creates a new empty migration.
- `npm run test`: run tests.
- `npm run test:coverage`: run tests with coverage metrics.
## Dependencies
- `express`: http://expressjs.com/ for our routing layer.
- `typeorm`: https://github.com/typeorm/typeorm as our ORM.
- `@hapi/joi`: https://github.com/hapijs/joi for json validation.
- `pino`: https://github.com/hapijs/joi for logging.
- `dotenv`: https://github.com/motdotla/dotenv for environment management.
- `pg`: https://github.com/motdotla/dotenv PostgreSQL adapter.
- `body-parser`: https://github.com/expressjs/body-parser middleware json parsing.
- `bull`: https://github.com/OptimalBits/bull#readme queue processing.
- `nodemailer`: https://nodemailer.com/ as our mail engine.
### Test Dependencies
- `mocha`: https://mochajs.org/ as our testing framework.
- `chai`: http://chaijs.com assertion library.
- `sinon`: https://sinonjs.org/ for mocks and stubs.
- `supertest`: https://github.com/visionmedia/supertest for router testing.
## Roadmap
The following features are planned to be added:
- [X] CircleCI configuration.
- [X] Docker configuration.
- [X] Error handling middleware.
- [ ] Session management using Passport.
- [X] Background jobs example setup.
## License
**Node-ts-api-base** is available under the MIT license. See the LICENSE file for more info.
## Credits
**Node-ts-api-base** is maintained by [Rootstrap](http://www.rootstrap.com) with the help of our [contributors](https://github.com/rootstrap/node-ts-api-base/contributors).
[
](http://www.rootstrap.com)