https://github.com/nitins87/rest-api-typescript

A REST API boilerplate written in TypeScript with Express, Jest, Supertest, ESLint, Prettier, ESLint, Nodemon, Debug, Winston, Morgan, Helmet, Cors, Dotenv, Zod, and more.
https://github.com/nitins87/rest-api-typescript

api cors debug eslint express helmet jest morgan nodejs-api nodemon prettier rest-api supertest types winston zod

Last synced: about 1 month ago
JSON representation

A REST API boilerplate written in TypeScript with Express, Jest, Supertest, ESLint, Prettier, ESLint, Nodemon, Debug, Winston, Morgan, Helmet, Cors, Dotenv, Zod, and more.

• Host: GitHub
• URL: https://github.com/nitins87/rest-api-typescript
• Owner: NitinS87
• Created: 2024-01-08T19:08:23.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-07-27T08:46:52.000Z (4 months ago)
• Last Synced: 2024-07-27T09:48:38.221Z (4 months ago)
• Topics: api, cors, debug, eslint, express, helmet, jest, morgan, nodejs-api, nodemon, prettier, rest-api, supertest, types, winston, zod
• Language: TypeScript
• Homepage:
• Size: 96.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Docker.md

Awesome Lists containing this project

README

        
### Building and running your application

When you're ready, start your application by running:

`docker compose up --build`.

Your application will be available at http://localhost:8000.

### Deploying your application to the cloud

First, build your image, e.g.: `docker build -t myapp .`.

If your cloud uses a different CPU architecture than your development

machine (e.g., you are on a Mac M1 and your cloud provider is amd64),

you'll want to build the image for that platform, e.g.:

`docker build --platform=linux/amd64 -t myapp .`.

Then, push it to your registry, e.g. `docker push myregistry.com/myapp`.

Consult Docker's [getting started](https://docs.docker.com/go/get-started-sharing/)

docs for more detail on building and pushing.

### References

* [Docker's Node.js guide](https://docs.docker.com/language/nodejs/)