w3cj / express-api-starter-ts

A basic starter for an express.js API with Typescript

Express API Starter with Typescript

How to use this template:

npx create-express-api --typescript --directory my-api-name

Includes API Server utilities:

• morgan
  • HTTP request logger middleware for node.js
• helmet
  • Helmet helps you secure your Express apps by setting various HTTP headers. It's not a silver bullet, but it can help!
• dotenv
  • Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env
• cors
  • CORS is a node.js package for providing a Connect/Express middleware that can be used to enable CORS with various options.

Development utilities:

• typescript
  • TypeScript is a language for application-scale JavaScript.
• ts-node
  • TypeScript execution and REPL for node.js, with source map and native ESM support.
• nodemon
  • nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected.
• eslint
  • ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
• typescript-eslint
  • Tooling which enables ESLint to support TypeScript.
• jest
  • Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
• supertest
  • HTTP assertions made easy via superagent.

Setup

npm install

Lint

npm run lint

Test

npm run test

Development

npm run dev

express-api-starter-ts's Issues

check out `create-ts-api`

A utility command to set up TypeScript, NodeJS, Express/GraphQL API project.

GIthub: https://github.com/bineetNaidu/create-ts-api

Run :

  npx create-ts-api
  cd <your-project-name>
  # OR
  yarn create ts-api
  cd <your-project-name>

Error running step 1 - npx installation

Issue running npx create-express-api --typescript --directory my-api-name.

Error message:

error: unknown option `typescript'

usage: git clone [<options>] [--] <repo> [<dir>]  

    -v, --verbose         be more verbose
    -q, --quiet           be more quiet
    --progress            force progress reporting
    -n, --no-checkout     don't create a checkout 
    --bare                create a bare repository
    --mirror              create a mirror repository (implies bare)
    -l, --local           to clone from a local repository
    --no-hardlinks        don't use local hardlinks, always copy
    -s, --shared          setup as shared repository
    --recurse-submodules[=<pathspec>]
                          initialize submodules in the clone
    --recursive[=<pathspec>]
                          alias of --recurse-submodules
    -j, --jobs <n>        number of submodules cloned in parallel
    --template <template-directory>
                          directory from which templates will be used
    --reference <repo>    reference repository
    --reference-if-able <repo>
                          reference repository
    --dissociate          use --reference only while cloning
    -o, --origin <name>   use <name> instead of 'origin' to track upstream
    -b, --branch <branch>
                          checkout <branch> instead of the remote's HEAD
    -u, --upload-pack <path>
                          path to git-upload-pack on the remote
    --depth <depth>       create a shallow clone of that depth
    --shallow-since <time>
                          create a shallow clone since a specific time
    --shallow-exclude <revision>
                          deepen history of shallow clone, excluding rev
    --single-branch       clone only one branch, HEAD or --branch
    --no-tags             don't clone any tags, and make later fetches not to follow them
    --shallow-submodules  any cloned submodules will be shallow
    --separate-git-dir <gitdir>
                          separate git dir from working tree
    -c, --config <key=value>
                          set config inside the new repository
    --server-option <server-specific>
                          option to transmit
    -4, --ipv4            use IPv4 addresses only
    -6, --ipv6            use IPv6 addresses only
    --filter <args>       object filtering
    --remote-submodules   any cloned submodules will use their remote-tracking branch
    --sparse              initialize sparse-checkout file to include only files at root


rm: unknown option -- typescript/.git

Try 'rm --help' for more information.

Installing dependencies...
node:events:491
      throw er; // Unhandled 'error' event
      ^

Error: spawn npm ENOENT
    at ChildProcess._handle.onexit (node:internal/child_process:283:19)
    at onErrorNT (node:internal/child_process:476:16)
    at process.processTicksAndRejections (node:internal/process/task_queues:82:21)
Emitted 'error' event on ChildProcess instance at:
    at ChildProcess._handle.onexit (node:internal/child_process:289:12)
    at onErrorNT (node:internal/child_process:476:16)
    at process.processTicksAndRejections (node:internal/process/task_queues:82:21) {
  errno: -4058,
  code: 'ENOENT',
  syscall: 'spawn npm',
  path: 'npm',
  spawnargs: [ 'install' ]
}

Node.js v18.13.0