diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4312b51..65da75c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,35 +4,32 @@ about: Create a report to help us improve title: '' labels: bug assignees: IKatsuba - --- -**Describe the bug** -A clear and concise description of what the bug is. +**Describe the bug** A clear and concise description of what the bug is. + +**To Reproduce** Steps to reproduce the behavior: -**To Reproduce** -Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** -A clear and concise description of what you expected to happen. +**Expected behavior** A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Screenshots** If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] **Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] -**Additional context** -Add any other context about the problem here. +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] + +**Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 510dc58..179300a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,17 +4,14 @@ about: Suggest an idea for this project title: '' labels: enhancement assignees: IKatsuba - --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**Is your feature request related to a problem? Please describe.** A clear and concise description +of what the problem is. Ex. I'm always frustrated when [...] -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +**Describe the solution you'd like** A clear and concise description of what you want to happen. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**Describe alternatives you've considered** A clear and concise description of any alternative +solutions or features you've considered. -**Additional context** -Add any other context or screenshots about the feature request here. +**Additional context** Add any other context or screenshots about the feature request here. diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5f0889c..d91a92a 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,7 +5,7 @@ version: 2 updates: - - package-ecosystem: "npm" # See documentation for possible values - directory: "/" # Location of package manifests + - package-ecosystem: 'npm' # See documentation for possible values + directory: '/' # Location of package manifests schedule: - interval: "weekly" + interval: 'weekly' diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..dfb54f9 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,28 @@ +name: CI + +on: + push: + branches: + - main + pull_request: + +permissions: + actions: read + contents: read + +jobs: + main: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v3 + with: + node-version: 20 + cache: 'npm' + - run: npm ci + - uses: nrwl/nx-set-shas@v4 + + - run: npx nx-cloud record -- nx format:check + - run: npx nx affected -t lint test diff --git a/README.md b/README.md index 84408f1..edf5a4e 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ a set of tools to help you to build your SaaS products faster and easier. - [x] **Projects**: Create projects inside your workspace. - [ ] **Members**: Invite members to your workspace. - [ ] **Roles**: Assign roles to workspace members. - - [x] **Subscription**: Manage workspace billing and subscription. + - [x] **Subscription**: Manage workspace billing and subscription. - [ ] **Settings**: Manage your workspace settings. - [ ] **Domains**: Manage workspace custom domains. - [ ] **Authentication**: Manage user authentication. diff --git a/apps/docs/api-reference/introduction.mdx b/apps/docs/api-reference/introduction.mdx index 36882d6..a22a80c 100644 --- a/apps/docs/api-reference/introduction.mdx +++ b/apps/docs/api-reference/introduction.mdx @@ -10,7 +10,6 @@ Welcome to the API reference documentation for the Saasfy API. The Saasfy API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. - ## Authentication To authenticate with the Saasfy API, you need to provide an API key in the `Authorization` header of your request. diff --git a/apps/docs/development.mdx b/apps/docs/development.mdx index 8783008..97565ad 100644 --- a/apps/docs/development.mdx +++ b/apps/docs/development.mdx @@ -3,10 +3,7 @@ title: 'Development' description: 'Learn how to preview changes locally' --- - - **Prerequisite** You should have installed Node.js (version 18.10.0 or - higher). - +**Prerequisite** You should have installed Node.js (version 18.10.0 or higher). Step 1. Install Mintlify on your OS: @@ -62,10 +59,7 @@ yarn global upgrade mintlify ## Deployment - - Unlimited editors available under the [Startup - Plan](https://mintlify.com/pricing) - +Unlimited editors available under the [Startup Plan](https://mintlify.com/pricing) You should see the following if the deploy successfully went through: diff --git a/apps/docs/introduction.mdx b/apps/docs/introduction.mdx index 2589c0b..e6bad47 100644 --- a/apps/docs/introduction.mdx +++ b/apps/docs/introduction.mdx @@ -3,34 +3,18 @@ title: Introduction description: 'Welcome to the home of your new documentation' --- -Hero Light -Hero Dark +Hero Light +Hero Dark ## Setting up The first step to world-class documentation is setting up your editing environments. - + Get your docs set up locally for easy development - + Preview your changes before you push to make sure they're perfect @@ -40,18 +24,10 @@ The first step to world-class documentation is setting up your editing environme Update your docs to your brand and add valuable content for the best user conversion. - + Customize your docs to your company's colors and brands - + Automatically generate endpoints from an OpenAPI spec Build interactive features and designs to guide your users - + Check out our showcase of our favorite documentation diff --git a/apps/docs/quickstart.mdx b/apps/docs/quickstart.mdx index d7f3486..29e6ace 100644 --- a/apps/docs/quickstart.mdx +++ b/apps/docs/quickstart.mdx @@ -11,20 +11,18 @@ Learn how to update your docs locally and and deploy them to the public. - During the onboarding process, we created a repository on your Github with - your docs content. You can find this repository on our - [dashboard](https://dashboard.mintlify.com). To clone the repository - locally, follow these + During the onboarding process, we created a repository on your Github with your docs content. + You can find this repository on our [dashboard](https://dashboard.mintlify.com). To clone the + repository locally, follow these [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) in your terminal. - Previewing helps you make sure your changes look as intended. We built a - command line interface to render these changes locally. 1. Install the - [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the - documentation changes locally with this command: ``` npm i -g mintlify ``` - 2. Run the following command at the root of your documentation (where - `mint.json` is): ``` mintlify dev ``` + Previewing helps you make sure your changes look as intended. We built a command line interface + to render these changes locally. 1. Install the [Mintlify + CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally with + this command: ``` npm i -g mintlify ``` 2. Run the following command at the root of your + documentation (where `mint.json` is): ``` mintlify dev ``` @@ -33,18 +31,17 @@ Learn how to update your docs locally and and deploy them to the public. - Our Github app automatically deploys your changes to your docs site, so you - don't need to manage deployments yourself. You can find the link to install on - your [dashboard](https://dashboard.mintlify.com). Once the bot has been - successfully installed, there should be a check mark next to the commit hash - of the repo. + Our Github app automatically deploys your changes to your docs site, so you don't need to manage + deployments yourself. You can find the link to install on your + [dashboard](https://dashboard.mintlify.com). Once the bot has been successfully installed, there + should be a check mark next to the commit hash of the repo. [Commit and push your changes to Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) - for your changes to update in your docs site. If you push and don't see that - the Github app successfully deployed your changes, you can also manually - update your docs through our [dashboard](https://dashboard.mintlify.com). + for your changes to update in your docs site. If you push and don't see that the Github app + successfully deployed your changes, you can also manually update your docs through our + [dashboard](https://dashboard.mintlify.com). @@ -59,27 +56,15 @@ Add content directly in your files with MDX syntax and React components. You can Add flair to your docs with personalized branding. - + Implement your OpenAPI spec and enable API user interaction. - + Draw insights from user interactions with your documentation. - + Keep your docs on your own website's subdomain. diff --git a/apps/web/jest.config.ts b/apps/web/jest.config.ts index d84a509..078206e 100644 --- a/apps/web/jest.config.ts +++ b/apps/web/jest.config.ts @@ -8,4 +8,5 @@ export default { }, moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'], coverageDirectory: '../../coverage/apps/web', + passWithNoTests: true, };