Giter Club home page Giter Club logo

eldhopaulose / ts-boilerplatex Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 46 KB

TS-BoilerplateX provides developers with a meticulously crafted foundation for building powerful web applications using TypeScript and Express.js, leveraging static typing and flexibility to expedite development while maintaining code integrity and ensuring maintainability.

License: Apache License 2.0

JavaScript 5.77% TypeScript 94.23%
backend backend-api eslint express-js expressjs javascript node-typescript node-typescript-boilerplate node-typescript-express nodejs

ts-boilerplatex's Introduction

TS-BoilerplateX

NodeJS Nodemon Express.js TypeScript

TS-BoilerplateX is a meticulously crafted boilerplate tailored for developers seeking a seamless starting point for building powerful web applications with TypeScript and Express.js. With TS-BoilerplateX, harness the combined benefits of TypeScript's static typing and Express.js' flexibility to expedite your development process while ensuring code integrity and maintainability.

Features

  • TypeScript support
  • Express.js integration
  • ESLint for code linting
  • Example controllers and routes
  • Comprehensive documentation
  • EditorConfig for consistent coding style

Installation

To quickly create an application skeleton, you can utilize the TS-BoilerplateX tool. You can run the application generator using the npx command.

npx ts-boilerplatex

To install TS-BoilerplateX, you can use npm:

npm install ts-boilerplatex
  • dev: Start the development server with nodemon.
  • start: Start the application using ts-node to execute src/main.ts.
  • lint: Run ESLint to lint source files in the src/ directory.
  • docs: Generate documentation using Typedoc from src/main.ts.
  • build: Compile TypeScript files using the TypeScript compiler (tsc) based on the tsconfig.json configuration.
  • build-all: Clean the build directory, then run build, esbuild-node, and esbuild-browser scripts.
  • clean: Remove build artifacts and generated documentation.

Project Structure

The project structure is organized as follows:

TS-BoilerplateX/
|-- bin/
|   -- server.ts
|-- controller/
|   -- indexController.ts
|-- routes/
|   -- index.ts
|-- README.md
|-- package.json
|-- tsconfig.json
`-- ...
  • bin/: Contains the server configuration.
  • controller/: Contains controller functions to handle route logic.
  • routes/: Contains route definitions.

Middleware

  • Morgan

    Morgan middleware is used for logging HTTP requests. It's configured to log requests in the "dev" format.

  • bodyParser

    bodyParser middleware is used to parse incoming JSON and URL-encoded requests. It's configured to handle JSON and URL-encoded requests with extended mode enabled.

  • compression

    compression middleware compresses HTTP responses before sending them to the client.

  • cookieParser

    cookieParser middleware is used to parse cookies attached to incoming requests.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

License

Licensed under the Apache-2.0. See the LICENSE file for details.

ts-boilerplatex's People

Contributors

eldhopaulose avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.