Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with detailed step for each feature configuration #50

Open
niwsa opened this issue Oct 15, 2022 · 11 comments
Open

Update README with detailed step for each feature configuration #50

niwsa opened this issue Oct 15, 2022 · 11 comments
Labels
good first issue Good for newcomers

Comments

@niwsa
Copy link
Member

niwsa commented Oct 15, 2022

No description provided.

@niwsa niwsa self-assigned this Oct 15, 2022
@niwsa niwsa changed the title Documentation boilerplate for starter kit usage Update README with detailed step for each feature configuration Oct 17, 2022
@devkiran devkiran added the good first issue Good for newcomers label Sep 11, 2023
@thevinitgupta
Copy link

Could you provide more context about the issue?

@devkiran
Copy link
Contributor

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.

@dasveloper
Copy link

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?

@Rbcoder1
Copy link

Rbcoder1 commented Oct 2, 2023

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

@Rbcoder1
Copy link

Rbcoder1 commented Oct 4, 2023

I work on it

@Rbcoder1
Copy link

Rbcoder1 commented Oct 5, 2023

I Need To Add A Seperate Section For This Detail Steps

@Rbcoder1
Copy link

Rbcoder1 commented Oct 5, 2023

  • 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

@devkiran
Copy link
Contributor

devkiran commented Oct 6, 2023

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

@Rbcoder1
Copy link

Rbcoder1 commented Oct 6, 2023

Where I Add These Step Section In Readme

@devkiran
Copy link
Contributor

devkiran commented Oct 6, 2023

Add a new section under Features

@Rbcoder1
Copy link

Rbcoder1 commented Oct 6, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

6 participants