chore: add base code for NestJS along with linting and CI

[nitesh-osmosys]

API PR Checklist

Pre-requisites

• I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
• I have performed preliminary unit testing.
• I have updated the required api docs as applicable.
• I have added/updated test cases to the test suite as applicable

PR Details

PR details have been updated as per the given format (see below)

• PR title adheres to the format specified in guidelines (e.g., feat: add admin login endpoint)
• Description has been added
• Related changes have been added (optional)
• Screenshots have been added (optional)
• Query request and response examples have been added (as applicable, in case added or updated)
• Documentation changes have been listed (as applicable)
• Test suite output is added (as applicable)
• Pending actions have been added (optional)
• Any other additional notes have been added (optional)

Additional Information

• Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
• Assignee(s) and reviewer(s) have been added (optional)

---

Description:

• Added code base for nest js along with linting rules and basic package libraries

Related changes:

• Added config->logger.config.ts file
• Updated main.ts
• Added linting rules
• Installed required packages

Screenshots:

Query request and response:

• Add any query request body, URL statement and response body for the made change or addition.

Documentation changes:

• NA

Test suite output:

• NA

Pending actions:

• NA

Additional notes:

• NA

Summary by CodeRabbit

• New Features
  • Added a greeting message feature to the root route in the API.
  • Introduced a GitHub Actions workflow for linting and building the Nest.js application on pull requests to the main branch.
• Documentation
  • Introduced comprehensive documentation for the API including installation, running, and testing instructions.
• Testing
  • Implemented unit tests for the AppController and end-to-end tests for the API.
• Chores
  • Configured ESLint, Prettier, and Jest for enhanced code quality and testing.
• Bug Fixes
  • Improved logging with file rotation to enhance diagnostics and troubleshooting.

[coderabbitai]

Walkthrough

Embarking on a Nest.js journey with a fresh GitHub Actions workflow christened "Standard Nest.js App Flow." This automation orchestrates code quality evaluations via linting and Nest.js application compilation triggered by pull requests to the main branch.

Changes

Files	Change Summary
.github/workflows/backend.yml	Introduces "Standard Nest.js App Flow" GitHub Actions workflow with "lint" and "build" jobs.
apps/api/package.json	Defines Node.js API project config for NestJS framework, encompassing build, format, start, test, and lint scripts, dependencies, devDependencies, and Jest settings.

🐰 "In the repository's core, a new rhythm unfurls,
GitHub Actions swirl, enhancing code with twirls.
'Lint' and 'build' perform a synchronized ballet,
Nest.js app shines bright, in a grand array.
🌟 CodeRabbit observes, as automation takes its place,
Graceful workflow unfolds, with elegance and embrace!"

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c1046a7 and 3045523.

Files ignored due to path filters (1)

• apps/api/package-lock.json is excluded by !**/package-lock.json

Files selected for processing (1)

• apps/api/package.json (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• apps/api/package.json

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 6

[xixas]

@nitesh-osmosys
Add this CI file in repo
https://github.com/OsmosysSoftware/osmo-x/blob/main/.github/workflows/backend.yml

[coderabbitai]

Actionable comments posted: 2