Skip to content
This repository has been archived by the owner on Jan 15, 2021. It is now read-only.

Commit

Permalink
Ignore all custom files (#1024)
Browse files Browse the repository at this point in the history
* Ignore all custom files

* Make NOTE more prominent in README.md

Co-authored-by: Leandro Boscariol <alfetopito@users.noreply.github.com>

Co-authored-by: Leandro Boscariol <alfetopito@users.noreply.github.com>
  • Loading branch information
anxolin and alfetopito authored May 22, 2020
1 parent 1fb0a31 commit b8611f8
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,17 @@ This app employs overrides from an alternative source (`custom/` directory) for
Override works for absolute paths that make use of baseUrl
That is if there are two files:

```js
src/pages/About.tsx
custom/pages/About.tsx
- `src/pages/About.tsx`
- `custom/pages/About.tsx`

```js
import About from 'pages/About'
// will try resolving from custom/ first and failing that from src/
```

> **NOTE**: If you are forking the project, you might want to delete the [custom/.gitignore](custom/.gitignore) file so you
> can commit a config file and components inside the custom directory.
## Config

Default app configs can be found on [the default config file](./config-default.yaml)
Expand All @@ -121,6 +124,9 @@ Both JSON and YAML formats are supported.

Simply replace any config found on [config-default](./config-default.yaml).

> NOTE: If you are forking the project, you might want to delete the [custom/.gitignore](custom/.gitignore) file so you
> can commit a config file and components inside the custom directory.
Below we provide details for each config.

### `name`
Expand Down
3 changes: 3 additions & 0 deletions custom/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ignore everything in "custom" directory
# NOTE: Forks that want to override the config or add conmponents, should delete this .gitignore file
*
Empty file removed custom/.gitkeep
Empty file.

0 comments on commit b8611f8

Please sign in to comment.