Skip to content

Commit

Permalink
Revamp tooling; add webtrees to dependency/build chain; clean up redu…
Browse files Browse the repository at this point in the history
…ndant styles
  • Loading branch information
jchue committed Mar 8, 2023
1 parent 4cddb81 commit a6cd612
Show file tree
Hide file tree
Showing 21 changed files with 45,829 additions and 2,791 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Dependency directories
node_modules/
vendor/

# Sass
.sass-cache/
Expand All @@ -8,8 +9,7 @@ node_modules/
*.scss.map

# Dev
resources/css/
resources/js/
dev/

# Build
dist/
Expand Down
3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
[submodule "src/scss/argon-dashboard"]
path = src/scss/argon-dashboard
url = [email protected]:creativetimofficial/argon-dashboard.git
[submodule "src/scss/BeautifyMarker"]
path = src/scss/BeautifyMarker
url = [email protected]:masajid390/BeautifyMarker.git
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,17 +56,26 @@ When change is made to these views in the webtrees codebase, it needs to be inco

**Clone repository**

Unfortunately, only `leaflet` and `tom-select` are available in the npm Registry. `argon-dashboard` and `BeautifyMarker` must be sourced as Git submodules.
`argon-dashboard` must be sourced as a Git submodules.

Therefore, you must pass the `--recurse-submodules` flag when cloning the repository in order for their contents to be populated:
Therefore, you must pass the `--recurse-submodules` flag when cloning the repository in order for its contents to be populated (under `src/resources/scss/argon-dashboard`):

```
git clone --recurse-submodules [email protected]:jchue/argon-webtrees-theme.git
```

**Install dependencies and run in watch mode**

To keep things simple, webtrees itself is not included nor is it enforced as a dependency. Just place the entire repository in the `modules_v4/` directory of webtrees, then run:
webtrees itself is a required dependency, since its base and vendor styles are utilized in the pipeline. First install it as well as its subdependencies:

```sh
composer install
npm run vendor
```

Composer is configured to install webtrees from source, so it should include the required stylesheets.

Then install the theme's Node dependencies and start the webpack watcher:

```sh
npm install
Expand Down
10 changes: 10 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"config": {
"preferred-install": {
"fisharebest/webtrees": "source"
}
},
"require-dev": {
"fisharebest/webtrees": "~2.1"
}
}
Loading

0 comments on commit a6cd612

Please sign in to comment.