Express API Starter with Typescript

Root endpoint:
    URL: https://typescript-api-alpha.vercel.app/api/v1/
    Method: GET

Scraping and indexing endpoint:
    URL: https://typescript-api-alpha.vercel.app/api/v1/indexing
    Method: GET

Deleting records by date endpoint:
    URL: https://typescript-api-alpha.vercel.app/api/v1/kurs/:date
    Method: DELETE
    Replace ":date" with the desired date in the format "YYYY-MM-DD".

Retrieving data within a date range endpoint:
    URL: https://typescript-api-alpha.vercel.app/api/v1/kurs/
    Method: GET
    Query Parameters:
        startdate: The start date of the range (format: "YYYY-MM-DD").
        enddate: The end date of the range (format: "YYYY-MM-DD").

Retrieving records by symbol within a date range endpoint:
    URL: https://typescript-api-alpha.vercel.app/api/v1/kurs/:symbol
    Method: GET
    Replace ":symbol" with the desired currency symbol (e.g., "USD", "EUR").
    Query Parameters:
        startdate: The start date of the range (format: "YYYY-MM-DD").
        enddate: The end date of the range (format: "YYYY-MM-DD").

Inserting new currency exchange rate records endpoint:
    URL: https://typescript-api-alpha.vercel.app/api/v1/kurs/
    Method: POST
    Request Body: Provide JSON data representing the new currency exchange rate record.

Updating currency exchange rate records endpoint:
    URL: https://typescript-api-alpha.vercel.app/api/v1/kurs/
    Method: PUT
    Request Body: Provide JSON data representing the updated currency exchange rate record.

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