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

Ci #8

Merged
merged 3 commits into from
Apr 20, 2024
Merged

Ci #8

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 15 additions & 18 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
15 changes: 6 additions & 9 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
28 changes: 28 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion apps/docs/api-reference/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 2 additions & 8 deletions apps/docs/development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@ title: 'Development'
description: 'Learn how to preview changes locally'
---

<Info>
**Prerequisite** You should have installed Node.js (version 18.10.0 or
higher).
</Info>
<Info>**Prerequisite** You should have installed Node.js (version 18.10.0 or higher).</Info>

Step 1. Install Mintlify on your OS:

Expand Down Expand Up @@ -62,10 +59,7 @@ yarn global upgrade mintlify

## Deployment

<Tip>
Unlimited editors available under the [Startup
Plan](https://mintlify.com/pricing)
</Tip>
<Tip>Unlimited editors available under the [Startup Plan](https://mintlify.com/pricing)</Tip>

You should see the following if the deploy successfully went through:

Expand Down
42 changes: 7 additions & 35 deletions apps/docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,18 @@ title: Introduction
description: 'Welcome to the home of your new documentation'
---

<img
className="block dark:hidden"
src="/images/hero-light.svg"
alt="Hero Light"
/>
<img
className="hidden dark:block"
src="/images/hero-dark.svg"
alt="Hero Dark"
/>
<img className="block dark:hidden" src="/images/hero-light.svg" alt="Hero Light" />
<img className="hidden dark:block" src="/images/hero-dark.svg" alt="Hero Dark" />

## Setting up

The first step to world-class documentation is setting up your editing environments.

<CardGroup cols={2}>
<Card
title="Edit Your Docs"
icon="pen-to-square"
href="https://mintlify.com/docs/quickstart"
>
<Card title="Edit Your Docs" icon="pen-to-square" href="https://mintlify.com/docs/quickstart">
Get your docs set up locally for easy development
</Card>
<Card
title="Preview Changes"
icon="image"
href="https://mintlify.com/docs/development"
>
<Card title="Preview Changes" icon="image" href="https://mintlify.com/docs/development">
Preview your changes before you push to make sure they're perfect
</Card>
</CardGroup>
Expand All @@ -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.

<CardGroup cols={2}>
<Card
title="Customize Style"
icon="palette"
href="https://mintlify.com/docs/settings/global"
>
<Card title="Customize Style" icon="palette" href="https://mintlify.com/docs/settings/global">
Customize your docs to your company's colors and brands
</Card>
<Card
title="Reference APIs"
icon="code"
href="https://mintlify.com/docs/api-playground/openapi"
>
<Card title="Reference APIs" icon="code" href="https://mintlify.com/docs/api-playground/openapi">
Automatically generate endpoints from an OpenAPI spec
</Card>
<Card
Expand All @@ -61,11 +37,7 @@ Update your docs to your brand and add valuable content for the best user conver
>
Build interactive features and designs to guide your users
</Card>
<Card
title="Get Inspiration"
icon="stars"
href="https://mintlify.com/customers"
>
<Card title="Get Inspiration" icon="stars" href="https://mintlify.com/customers">
Check out our showcase of our favorite documentation
</Card>
</CardGroup>
51 changes: 18 additions & 33 deletions apps/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,18 @@ Learn how to update your docs locally and and deploy them to the public.

<AccordionGroup>
<Accordion icon="github" title="Clone your docs locally">
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.
</Accordion>
<Accordion icon="rectangle-terminal" title="Preview changes">
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 ```
</Accordion>
</AccordionGroup>

Expand All @@ -33,18 +31,17 @@ Learn how to update your docs locally and and deploy them to the public.
<AccordionGroup>

<Accordion icon="message-bot" title="Install our Github app">
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.
</Accordion>
<Accordion icon="rocket" title="Push your changes">
[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).
</Accordion>

</AccordionGroup>
Expand All @@ -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.
</Card>

<Card
title="Add API Endpoints"
icon="square-code"
href="/api-playground/configuration"
>
<Card title="Add API Endpoints" icon="square-code" href="/api-playground/configuration">
Implement your OpenAPI spec and enable API user interaction.
</Card>

<Card
title="Integrate Analytics"
icon="chart-mixed"
href="/analytics/supported-integrations"
>
<Card title="Integrate Analytics" icon="chart-mixed" href="/analytics/supported-integrations">
Draw insights from user interactions with your documentation.
</Card>

<Card
title="Host on a Custom Domain"
icon="browser"
href="/settings/custom-domain/subdomain"
>
<Card title="Host on a Custom Domain" icon="browser" href="/settings/custom-domain/subdomain">
Keep your docs on your own website's subdomain.
</Card>

Expand Down
1 change: 1 addition & 0 deletions apps/web/jest.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ export default {
},
moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
coverageDirectory: '../../coverage/apps/web',
passWithNoTests: true,
};
Loading