Work in Progress: Enhancing Documentation for Local Development Setup

[RDelorier]

Type of Change

Improvement to developer onboarding and experience.

Purpose of Change

To streamline the local setup process, including system requirements, and make it easier for new developers to start contributing.

Summary of Changes

• Added .nvmrc file specifying Node.js version "20" based on nvm i feedback.
  • Alternatively, this step can be handled using a Docker command with the appropriate image.

Next Steps

I will re-clone this project from the current state and write up the steps to get it running locally to provide the best developer experience. This will include:

• Documenting the steps required to complete the setup:
  • System requirements:
    • Node.js 20.x (via nvm or Docker)
    • Docker (if opting for a containerized setup)
  • Installing nvm (if not using Docker).
  • Copying .env.example to .env.
  • Troubleshooting startup issues (e.g., ports in use, environment variables not set, etc.).

[vercel]

@RDelorier is attempting to deploy a commit to the Listinai Team on Vercel.

A member of the Team first needs to authorize it.

[nevo-david]

Thank you so much @RDelorier!
Should I hold on to this until you finish?

[RDelorier]

Thank you so much @RDelorier! Should I hold on to this until you finish?

I want to be sure the docs are accurate and up to date with the current project dependencies, so please hold off on anything until I ping you here. Just wanted to get this PR started.

I really liked your post here and wanted to add some of my own open-source contributions to one of the projects you mentioned.

[nevo-david]

Awesome!
Can't wait to get your contributions!

[RDelorier]

Hey @nevo-david sorry for the delay, I should be able to wrap this up this evening.

[nevo-david]

Awesome, let me know :)