docs: improve api development setup doc

[ghost]

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 testing using the test suite to ensure that any existing features are not impacted and any new features are working as expected.
• 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:
This PR updates the API development setup documentation to add and improve missing/existing content in the document.

Related changes:
Mentioned in Documentation changes

Screenshots:
N/A

Query request and response:
N/A

Documentation changes:

• Remove un-required line in introduction part
• Add command to install node 20 using nvm in prerequisites
• Add commands to check status of mariadb and redis services
• Update command when cloning repo to cd to the api folder
• Make some other formatting changes to document structure

Test suite output:
N/A

Pending actions:
N/A

Additional notes:
N/A

Summary by CodeRabbit

• Documentation
  • Updated the development setup guide with new Node.js installation instructions.
  • Improved clarity on database setup and application configuration steps.
  • Added checks for Redis and MariaDB status in the setup process.
  • Enhanced instructions for starting the development server.

[coderabbitai]

Walkthrough

The recent update enhances the development setup documentation for an API project. It streamlines the process by updating Node.js installation instructions, refining repository cloning, and ensuring essential services like Redis and MariaDB are correctly checked. It also improves the initial configuration guidance and database setup clarity, alongside better instructions for booting up the development server.

Changes

Files	Change Summary
.../development-setup.md	- Updated Node.js via NVM - Repository name updated in clone step - Added Redis/MariaDB checks - Updated .env.example usage - Clarified database setup - Improved server start instructions

🐇✨

In the burrow of code, where the digital rabbits dwell,
A document was polished, with a magical spell.
"To ease your setup," the CodeRabbit did say,
"Follow these steps, and you'll be on your way!"
With a hop and a skip, in the server's bright gleam,
Our apps come to life, as if in a dream.
🌟📝🚀

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c77fa4b and 7d5eeee.

Files selected for processing (1)

• apps/api/docs/development-setup.md (3 hunks)

Additional comments: 6

apps/api/docs/development-setup.md (6)

• 10-10: Node.js version specified as v20.x or higher aligns with the PR objectives. Ensure that this version is supported by all dependencies.
• 21-24: Commands for checking the status of Redis and MariaDB services are clear and correctly formatted. Verify that these commands are universally applicable across different operating systems or add a note for OS-specific variations.
• 31-32: The repository name in the clone step has been updated correctly. Ensure the path cd osmo-x/apps/api accurately reflects the project's directory structure.
• 90-90: Mentioning the use of .env.example for configuration is a good practice. Ensure that the .env.example file is up-to-date with all necessary environment variables.
• 96-102: Database setup steps are clarified with the inclusion of running migrations. Ensure the command npm run typeorm:run-migration is correctly named and functional.
• 110-110: Instructions for starting the development server are improved. Confirm that npm run start:dev is the correct command and that it works as expected.