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

Fix: 'vtex.env' file description #1337

Merged
merged 1 commit into from
Aug 16, 2024
Merged
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
8 changes: 4 additions & 4 deletions docs/faststore/docs/reference/project-structure/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: 'Understanding the Project Structure'

In the previous guide of this track, you started your first FastStore project, learned how to run a local server, and made your first changes to the storefront. Now, it is time to understand how a FastStore project is structured.

By understanding the structure of a FastStore project, you can better navigate the codebase and make customizations to fit your specific needs.
Understanding the structure of a FastStore project can help you navigate the codebase and customize it to fit your specific needs.

Let's start taking a look at the structure that represents the source code of a FastStore project:

Expand Down Expand Up @@ -39,7 +39,7 @@ Let's start taking a look at the structure that represents the source code of a

## Files

- `custom-theme.scss` - Holds the styling information for your store, controlling the graphic elements such as typography, colors, borders, and spacing that provide your store with a unique look and feel.
- `custom-theme.scss` - Holds the styling information for your store, controlling the graphic elements such as typography, colors, borders, and spacing that give your store with a unique look and feel.

- `cypress.config.ts` - Configures the options and preferences required for running tests with Cypress.

Expand All @@ -50,7 +50,7 @@ For more information on configuration options for this file, refer to [Configura

- `tsconfig.json` - Configures the compiler options and project settings for TypeScript, including target version, module resolution, and source file locations.

- `vtex.env` - Holds environment variables that your application can access during runtime, such as API keys and database credentials.
- `vtex.env` - Stores public environment variables that your application can access during runtime. These include flags like `SITE_HOST` (specifying the store's domain in production) and other publicly accessible values, including feature flags, URLs, and Analytics public tracking IDs. For private environment variables such as API keys and database credentials, use [VTEX secrets](https://v1.faststore.dev/how-to-guides/webops/security/setting-up-secrets).
barbara-celi marked this conversation as resolved.
Show resolved Hide resolved

- `yarn.lock` - Locks down the exact versions of your project's dependencies, including transitive dependencies, to ensure consistent builds across different machines and environments. This file is automatically generated based on the dependencies in your `package.json` file.

Expand Down Expand Up @@ -79,7 +79,7 @@ The SDKs also provide GA4-compatible analytics functions to help you create powe

Gathers the design system based on FastStore components, using [Sass](https://sass-lang.com/) for styling. For more information, refer to the [FastStore UI](https://developers.vtex.com/docs/guides/faststore/components-index) guide.

> ℹ️ Although the components use [Sass](https://sass-lang.com/), you can work with the desired tool for styling.
> ℹ️ Although the components use [Sass](https://sass-lang.com/), you can style them using the desired tool for styling.

#### `@faststore/api`

Expand Down
Loading