saas-starter-kit icon indicating copy to clipboard operation
saas-starter-kit copied to clipboard

Published 20 hours ago • verified publisher icon boxyhq

Update README with detailed step for each feature configuration

Open niwsa opened this issue 3 years ago • 13 comments
trafficstars

niwsa avatar Oct 15 '22 17:10 niwsa

Could you provide more context about the issue?

thevinitgupta avatar Sep 18 '23 17:09 thevinitgupta

Sure, boxyhq/saas-starter-kit uses various services (Jackson, Retraced, Svix, etc). We need to update the README with detailed steps for each feature configuration. For example, how to configure Jackson, how to configure Retraced, etc. So that it is easy for the user to follow the steps and configure the services.

devkiran avatar Sep 19 '23 05:09 devkiran

Sure, boxyhq/saas-starter-kit uses various services (Jackson, Retraced, Svix, etc). We need to update the README with detailed steps for each feature configuration. For example, how to configure Jackson, how to configure Retraced, etc. So that it is easy for the user to follow the steps and configure the services.

I'd also love if the readme could have some descriptions about why we're setting up certain things, like I see we're using Svix to emit on user/team CRUD operations, but why? Is it just an example or is that required for some functionality?

dasveloper avatar Sep 19 '23 21:09 dasveloper

I have register for hacktoberfest2023. Can you please assign this issue so started to work on it

Rbcoder1 avatar Oct 02 '23 02:10 Rbcoder1

I work on it

Rbcoder1 avatar Oct 04 '23 02:10 Rbcoder1

I Need To Add A Seperate Section For This Detail Steps

Rbcoder1 avatar Oct 05 '23 15:10 Rbcoder1

  • Next.js
  • Tailwind CSS
  • Postgres
  • React
  • Prisma
  • TypeScript
  • SAML Jackson
  • Svix
  • Retraced

This Are The Services We Are Using So I Need To Write Steps To Configure Them Ok

Rbcoder1 avatar Oct 05 '23 15:10 Rbcoder1

@Rbcoder1 For SAML Jackson, Svix and Retraced. Link to the right documentation.

devkiran avatar Oct 06 '23 04:10 devkiran

Where I Add These Step Section In Readme

Rbcoder1 avatar Oct 06 '23 05:10 Rbcoder1

Add a new section under Features

devkiran avatar Oct 06 '23 05:10 devkiran

Ok

On Fri, 6 Oct 2023, 11:00 am Kiran K, @.***> wrote:

Add a new section under Features

— Reply to this email directly, view it on GitHub https://github.com/boxyhq/saas-starter-kit/issues/50#issuecomment-1750006998, or unsubscribe https://github.com/notifications/unsubscribe-auth/AZRVEQV2OJRDZWIEL3SERBDX56JQZAVCNFSM6AAAAAARF7WKC2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONJQGAYDMOJZHA . You are receiving this because you were mentioned.Message ID: @.***>

Rbcoder1 avatar Oct 06 '23 11:10 Rbcoder1

Can we get some renewed focus on this? Having minimum .env config or add all setup steps would help for new adopters. For example having guided output on dependency setup or npm run dev failures would be helpful

Getting my dev environment running with a DB and minimal .env config. This is my current output - any guidance appreciated:

npm run dev

> [email protected] dev
> next dev --port 4002

  â–² Next.js 14.2.4
  - Local:        http://localhost:4002
  - Environments: .env
  - Experiments (use with caution):
    · esmExternals
    · webpackBuildWorker
    · instrumentationHook

 ✓ Starting...

Then exits process

tobalo avatar Jun 20 '24 16:06 tobalo

@tobalo We have an example env here: https://github.com/boxyhq/saas-starter-kit/blob/main/.env.example . Does that help ? Could you outline the specific issue that you are facing ?

niwsa avatar Jun 27 '24 15:06 niwsa