node_project_contents.md

copyright	years 2015, 2017
lastupdated	2017-10-04

Node.js Project Files

{: #node-project-files}

The following table lists all the common directories and files in a generated Node.js project.

Directory / File	Description
./
package.json	Metadata file
idt.js	Wrapper for the IBM Developer Tools command
cli-config.yml	CLI configuration options
manifest.yml	Cloud Foundry deployment file
Dockerfile	Dockerfile for bx dev run, bx dev deploy, and docker commands
Dockerfile-tools	Dockerfile for bx dev build and bx dev test
docker-compose.yml	App service configuration for Docker Compose
gulpfile.js	Gulp configuration for running tasks when using Webpack
webpack.config.js	Webpack configuration for build related information
LICENSE
README.md	Description of project
./public/
swagger.yml	Swagger specification for describing REST APIs
./public/index.html
index.html	Skeleton markup for web applications
./public/server/
server.js	Server implementation file
./test/
test-server.js	Utility methods for testing with Kitura
./.bluemix/
container_build.sh
deploy.json
kube_deploy.sh
pipeline.yml	IBM Cloud pipeline definition
toolchain.yml	IBM Cloud toolchain definition
./chart/<projectname>/
Chart.yaml	Helm chart
values.yaml	Helm chart values
./chart/<projectname>/templates/
deployment.yaml	Deployment template
service.yaml	Service template