Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thedigitalninja/sample-ts-app
Just a sample TS App for testing deployments and such
https://github.com/thedigitalninja/sample-ts-app
Last synced: about 1 month ago
JSON representation
Just a sample TS App for testing deployments and such
- Host: GitHub
- URL: https://github.com/thedigitalninja/sample-ts-app
- Owner: TheDigitalNinja
- Created: 2023-12-13T18:58:32.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-18T20:03:06.000Z (about 1 year ago)
- Last Synced: 2024-10-12T19:44:55.529Z (2 months ago)
- Language: TypeScript
- Size: 117 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sample TS App
This is a Node.js application built with Express and TypeScript.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Application](#running-the-application)
- [Running Tests](#running-tests)
- [Linting](#linting)
- [Docker](#docker)
- [Healthcheck Endpoint](#healthcheck-endpoint)
## Prerequisites
- Node.js
- npm
## Installation
Clone the repository and install the dependencies:
```sh
git clone https://github.com/TheDigitalNinja/Sample-TS-App.git
npm install
```
## Running the Application
To run the application in development mode, use:
```sh
npm run dev
```
This will start the application with nodemon, which will automatically restart the server whenever you make changes to the source code.
To build the application for production, use:
```sh
npm run build
```
This will compile the TypeScript code into JavaScript.
To start the application in production mode, use:
```sh
npm start
```
This will start the compiled JavaScript code.
## Running Tests
To run the tests, use:
```sh
npm test
```
This will run the tests with Jest.
## Linting
To lint the code, use:
```sh
npm run lint
```
This will lint the code with ESLint.
## Healthcheck Endpoint
Our application includes a healthcheck endpoint (`/health`). This endpoint is used to check the health of our application. It's useful in a production environment to ensure that the application is running correctly and to take action if it's not.
Here's how you can use the healthcheck endpoint:
```sh
curl http://localhost:3000/health
```
## Docker
This application includes a Dockerfile that you can use to build a Docker image of the application. Here's how you can do it:
```sh
docker build -t sample-ts-app .
```
This will build a Docker image of the application and tag it as `sample-ts-app`.
To run the application in a Docker container, use:
```sh
docker run -p 3000:3000 sample-ts-app
```
This will start a Docker container from the my-application image and map port 3000 in the container to port 3000 on your machine.
You can then access the application at [http://localhost:3000](http://localhost:3000).