dock-cd

1.1.0 • Public • Published

Dock-CD ⚡🐋

npm package

Docker Create & Deploy

Dockerized Full Stack Web Application (frontend, backend, and database) Project Generator. Create and Deploy your Full Stack Web Application in minutes.

Dock-CD is a fullstack CLI tool that helps you to create and deploy your fullstack web application in minutes. It is dockerized, so you don't need to worry about deployment. It is also easy to use, you just need to select your tech stacks and the project will be generated automatically.

Dock-CD consists of 3 major parts:

Features

  • 💡Easy to use
  • 🐋Dockerized (no need to worry about deployment)

Usage

$ npx dock-cd@latest

You will be prompted to enter your project name and choose your tech stacks. Then, the project will be generated automatically in the current directory.

Example prompts:

image

If you wish to create example database data and connection, a little mock data for the database will be generated automatically and the code to connect to the database will be added to the backend.

After Project Generation

The generated project will be in this directory structure:

project-name
├── backend
│   ├── prisma
│   │   └── schema.prisma
│   ├── package.json
│   ├── index.[js,ts]
│   ├── prisma.[js,ts]
│   ├── .env
│   └── ...
├── frontend
│   ├── public
│   │   └── ...
│   ├── src
│   │   └── ...
│   ├── index.html
│   ├── package.json
│   ├── vite.config.[js,ts] (except vanilla or lit)
│   └── ...
├── docker-compose.yml
├── Dockerfile
├── .env
└── package.json

To start developing, run:

$ cd [project-name]
$ docker-compose up db -d
$ npm i && npm run install-all && npm run dev

The port 5173 will be used for the frontend and 3000 for the backend.

To change the frontend port, you can change the port from vite.config.[js,ts] file.

export default defineConfig({
  // ...other configs
  server: {
    port: 3001, // change this port
  },
});

To change the backend port, you can change the port from backend/index.[js,ts] file. Don't forget, if you are using non vanilla or lit version of the frontend, you also need to change the proxy port in vite.config.[js,ts] file.

export default defineConfig({
  proxy: {
    "/api": {
      target: "http://localhost:3000", // change this port
      changeOrigin: true,
    },
  },
  // ...other configs
});

To deploy, run:

$ cd [project-name]
$ docker-compose up -d --build

The frontend will be served as static files from the backend and will be exposed in the default port, 3000. If you want to serve it in another port, you can change the port from the .env file.

[!WARNING] Before actually deploying it to the server, you need to change the database password both in the .env and backend/.env file.

Tech Stacks


Made with ♥️ By Jovan Shelomo

Package Sidebar

Install

npm i dock-cd

Weekly Downloads

0

Version

1.1.0

License

ISC

Unpacked Size

34.7 kB

Total Files

23

Last publish

Collaborators

  • planetxx2