lux/explore
2
0
Fork 0
mirror of https://github.com/luxfi/explore.git synced 2026-09-24 00:28:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve grammar, capitalization, and consistency (#2432)

Browse Source 
* Update CONTRIBUTING.md

* Update BUILD-TIME_ENVS.md
This commit is contained in:
Danil
2024-11-29 15:27:16 +01:00
committed by GitHub
parent da6b2f2b87
commit 1264a38780
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/BUILD-TIME_ENVS.md
+1 -1
View File
@@ -5,5 +5,5 @@ These variables are passed to the app during the image build process. They canno
| Variable | Type | Description | Optional | Example value |
| --- | --- | --- | --- | --- |
| NEXT_PUBLIC_GIT_COMMIT_SHA | `string` | SHA of the latest commit in the branch from which image is built | false | `29d0613e` |
| NEXT_PUBLIC_GIT_TAG | `string` | Git tag on the latest commit in the branch from which image is built | true | `v1.0.0` |
| NEXT_PUBLIC_GIT_TAG | `string` | Git tag of the latest commit in the branch from which image is built | true | `v1.0.0` |
| NEXT_OPEN_TELEMETRY_ENABLED | `boolean` | Enables OpenTelemetry SDK | true | `true` |
docs/CONTRIBUTING.md
+5 -5
View File
@@ -50,14 +50,14 @@ A. Custom configuration:
1. Create `.env.local` file in the root folder and include all required environment variables from the [list](./ENVS.md)
2. Optionally, clone `.env.example` and name it `.env.secrets`. Fill it with necessary secrets for integrating with [external services](./ENVS.md#external-services-configuration). Include only secrets you need.
3. Use `yarn dev` command to start the dev server.
3. Use `yarn dev` command to start the Dev Server.
4. Open your browser and navigate to the URL provided in the command line output (by default, it is `http://localhost:3000`).
B. Pre-defined configuration:
1. Optionally, clone `.env.example` file into `configs/envs/.env.secrets`. Fill it with necessary secrets for integrating with [external services](./ENVS.md#external-services-configuration). Include only secrets your need.
2. Choose one of the predefined configurations located in the `/configs/envs` folder.
3. Start your local dev server using the `yarn dev:preset <config_preset_name>` command.
3. Start your local Dev Server using the `yarn dev:preset <config_preset_name>` command.
4. Open your browser and navigate to the URL provided in the command line output (by default, it is `http://localhost:3000`).
@@ -174,8 +174,8 @@ We have 3 pre-configured projects. You can run your test with the desired projec
| Command | Description |
| --- | --- |
| **Running and building** |
| `yarn dev` | run local dev server with user's configuration |
| `yarn dev:preset <config_preset_name>` | run local dev server with predefined configuration |
| `yarn dev` | run local Dev Server with user's configuration |
| `yarn dev:preset <config_preset_name>` | run local Dev Server with predefined configuration |
| `yarn build:docker` | build a docker image locally |
| `yarn start:docker:local` | start an application from previously built local docker image with user's configuration |
| `yarn start:docker:preset <config_preset_name>` | start an application from previously built local docker image with predefined configuration |
@@ -200,7 +200,7 @@ We have 3 pre-configured projects. You can run your test with the desired projec
#### VSCode
There are some predefined tasks for all commands described above. You can see its full list by pressing <kbd>cmd + shift + P</kbd> and using command `Task: Run task`
There are some predefined tasks for all commands described above. You can see the full list by pressing <kbd>cmd + shift + P</kbd> and using command `Task: Run task`
Also there is a Jest test launch configuration for debugging and running current test file in the watch mode.