postiz-app icon indicating copy to clipboard operation
postiz-app copied to clipboard

Published 20 hours ago • verified publisher icon gitroomhq

Work in Progress: Enhancing Documentation for Local Development Setup

Open RDelorier opened this issue 1 year ago • 7 comments

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.).

RDelorier avatar May 15 '24 06:05 RDelorier

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

A member of the Team first needs to authorize it.

vercel[bot] avatar May 15 '24 06:05 vercel[bot]

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

nevo-david avatar May 15 '24 06:05 nevo-david

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.

RDelorier avatar May 15 '24 06:05 RDelorier

Awesome! Can't wait to get your contributions!

nevo-david avatar May 15 '24 06:05 nevo-david

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

RDelorier avatar May 25 '24 14:05 RDelorier

Awesome, let me know :)

nevo-david avatar May 26 '24 09:05 nevo-david

Heya @RDelorier , we've recently done a bunch of work to get the project ready to be dockerized. Do you think it makes sense to reset this PR?

jamesread avatar Sep 09 '24 20:09 jamesread

Heya, there have been some pretty radical improvements to this project in the last few weeks for new users - must better docs for configuration (docs.postiz.com), a Docker image (with preinstalled npm, node, etc), and similar, which I think address all your concerns you first raised.

There's been no reply in 2 weeks, so I'll assume it's Ok to close, but please, do re-open or comment if you've got more good ideas :-)

jamesread avatar Sep 25 '24 23:09 jamesread