Skip to content

Commit

Permalink
[FEAT] Fixed some issues with examples and added necessary template a…
Browse files Browse the repository at this point in the history
…nd Security Policy (#29)
  • Loading branch information
blanklob committed Mar 5, 2023
1 parent fa61834 commit 7663101
Show file tree
Hide file tree
Showing 20 changed files with 570 additions and 19 deletions.
5 changes: 5 additions & 0 deletions .changeset/sweet-pets-care.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'create-adastra': patch
---

Added new template called necessary that comes with Shopify and Vite CLI instead of Adastra CLI
131 changes: 131 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][mozilla coc].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[mozilla coc]: https://github.com/mozilla/diversity
[faq]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,17 @@ Adastra ✨ comes with so many examples to showcase, how it can be used with all

| Theme/Example | Command |
| --------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| [Basics Template (Tailwind & Prettier)](./templates/basics) | `npm create adastra@latest -- --template basics` |
| [Minimal Template](./templates/minimal) | `npm create adastra@latest -- --template minimal` |
| [Basics Template (Tailwind)](./templates/basics) | `npm create adastra@latest -- --template basics` |
| [Minimal Template](./templates/necessary) | `npm create adastra@latest -- --template necessary` |
| [Example with React](./examples/with-react) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-react` |
| [Example with Vue](./examples/with-vue) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-vue` |
| [Example with Preact](./examples/with-preact) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-preact` |
| [Example with Solid](./examples/with-solid) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-solid` |
| [Example with Typescript](./examples/with-typescript) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-typescript` |
| [Example with Lit](./examples/with-lit) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-lit` |
| [Example with Alpine](./examples/with-alpine) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-alpine` |
| [Example with Tailwind](./examples/with-tailwind) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-tailwind` |
| [Example with GSAP](./examples/with-gsap) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-gsap` |
| [Example with Sass](./examples/with-sass) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-sass` |
| [Example with Less](./examples/with-less) | `npm create adastra@latest -- --template blanklob/adastra/examples/with-less` |
Expand Down
25 changes: 25 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Adastra Security

## Reporting a Vulnerability

To report a security issue, please email itsblanklob@gmail.com with a detailed description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue.

Please remember to include everything required for us to reproduce the issue, including but not limited to a publicly accessible git repository. All code samples shared with our Security team will only be used to verify and diagnose the issue and will not be publicly shared with anyone outside of Adastra teams. Adastra's Security Team members may share information only within the Adastra teams on a need-to-know basis to fix the related issue in Adastra.

Our Security team will acknowledge receiving your email within 3 working days.

<ins>**If you think you've found a security issue, please DO NOT report, discuss, or describe it on Discord, GitHub, or any other public forum; without prior contact and acknowledgment of Adastra's Security team.**<ins>

This project follows a 90 day disclosure timeline.

**_This is detrimental to the safety of all Adastra users. No exceptions._**

## Embargo Policy

The information members and others receive through participation in this group must not be made public, shared, or even hinted otherwise, except with prior explicit approval (which shall be handled on a case-by-case basis). This holds true until the agreed-upon public disclosure date/time is satisfied.

As a clarifying example, this policy forbids Adastra Security members from sharing list information with their employers; unless prior arrangements have been made directly with an employer.

In the unfortunate event that you share the information beyond what is allowed by this policy, you must urgently inform the Adastra Security Team of exactly what information leaked and to whom, as well as the steps that will be taken to prevent future leaks.

**Repeated offenses may lead to the removal from the Security or Adastra team.**
2 changes: 1 addition & 1 deletion examples/with-alpine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-alpine

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-alpine](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)

## Launch development server

Expand Down
2 changes: 1 addition & 1 deletion examples/with-gsap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-gsap

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-gsap](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)

## Launch development server

Expand Down
2 changes: 1 addition & 1 deletion examples/with-less/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-less

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-less](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)

## Launch development server

Expand Down
2 changes: 1 addition & 1 deletion examples/with-lit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-lit

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-lit](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)

## Launch development server

Expand Down
2 changes: 1 addition & 1 deletion examples/with-preact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-preact

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-preact](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)

## Launch development server

Expand Down
2 changes: 1 addition & 1 deletion examples/with-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-react

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-react](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)

## Launch development server

Expand Down
2 changes: 1 addition & 1 deletion examples/with-sass/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-sass

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-sass](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)

## Launch development server

Expand Down
2 changes: 1 addition & 1 deletion examples/with-solid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-solid

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-solid](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)

## Launch development server

Expand Down
2 changes: 1 addition & 1 deletion examples/with-tailwind/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-tailwind

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-tailwind](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/basics-template-banner.png)

## Launch development server

Expand Down
12 changes: 7 additions & 5 deletions examples/with-tailwind/templates/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@
"settings": {
"heading": "Documentation",
"description": "Find in-depth infos about Adastra features and how to use it.",
"link": "https://github.com/blanklob/adastra#documentation"
"link": "https:\/\/github.com\/blanklob\/adastra#documentation"
}
},
"a22569eb-f893-42d9-8751-b40c8df557f3": {
"type": "card-block",
"settings": {
"heading": "Chat",
"description": "Come say hey to our amazing Discord community 💚",
"link": "https://help.blanklob.com?utm_source=create-adastra&amp;utm_medium=basic-example&amp;utm_campaign=create-adastra"
"link": "https:\/\/help.blanklob.com?utm_source=create-adastra&amp;utm_medium=basic-example&amp;utm_campaign=create-adastra"
}
},
"cfe4f931-6e00-4854-8052-8600ec0e4208": {
Expand Down Expand Up @@ -44,10 +44,12 @@
],
"settings": {
"heading": "Welcome to Adastra ✨",
"instruction_1": "Currently there is no products in your store. To get started <strong>create your first product</strong> and set its price and quantity.",
"instruction_2": "<strong>Code Challenge: </strong>Tweak this button so when we add to cart, it shows a spinner. Check the <span>src/components</span> directory!"
"instruction_1": "Currently there is no products in your store. To get started <strong>create your first product<\/strong> and set its price and quantity.",
"instruction_2": "<strong>Code Challenge: <\/strong>Tweak this button so when we add to cart, it shows a spinner. Check the <span>src\/components<\/span> directory!"
}
}
},
"order": ["main"]
"order": [
"main"
]
}
2 changes: 1 addition & 1 deletion examples/with-typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn create adastra@latest --template blanklob/adastra/examples/with-typescript

> 🧑‍🚀 **Hey astronaut?** Have fun building Shopify themes with Adastra!
![necessary](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)
![with-typescript](https://raw.githubusercontent.com/blanklob/adastra/main/.github/assets/minimal-template-banner.png)

## Launch development server

Expand Down

0 comments on commit 7663101

Please sign in to comment.