bmolinh/nestjs-form-builder-ms

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Project setup

$ npm install

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Operations

Health Check

You can check the health of the application by making a GET request to the / endpoint:

$ curl http://localhost:3000/

Forms

The application provides several endpoints to manage forms:

• Create a Form: POST /forms
• Submit a Form: POST /forms/:id
• Get All Forms: GET /forms
• Get a Form by ID: GET /forms/:id
• Update a Form: PATCH /forms/:id
• Delete a Form: DELETE /forms/:id

Example Requests

Create a Form

curl -X POST http://localhost:3000/forms -H "Content-Type: application/json" -d '{
  "name": "Test Form",
  "description": "Test Description",
  "fields": [
    {
      "name": "Test Field",
      "label": "Test Label",
      "type": "text",
      "required": true
    }
  ]
}'

Submit a Form

curl -X POST http://localhost:3000/forms/1 -H "Content-Type: application/json" -d '{
  "answers": [
    {
      "fieldId": 1,
      "value": "Test Answer"
    }
  ]
}'

Get All Forms

curl http://localhost:3000/forms

Get a Form by ID

curl http://localhost:3000/forms/1

Update a Form

curl -X PATCH http://localhost:3000/forms/1 -H "Content-Type: application/json" -d '{
  "name": "Updated Form",
  "description": "Updated Description",
  "fields": [
    {
      "id": 1,
      "name": "Updated Field",
      "label": "Updated Label",
      "type": "text",
      "required": true
    }
  ]
}'

Delete a Form

curl -X DELETE http://localhost:3000/forms/1

Dockerization

You can build and run the application using Docker. The following steps will guide you through the process:

Build the Docker Image

$ npm run docker:build

Run the Docker Container

$ npm run docker:run

Stop the Docker Container

$ npm run docker:stop

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.