Skip to content

Commit

Permalink
#97 exclusions file for plugin release tool (#99)
Browse files Browse the repository at this point in the history
  • Loading branch information
kaitlinnewson authored Nov 12, 2024
1 parent ef29e60 commit c4bd2d3
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@ This theme can be installed through the **Plugin Gallery** in Open Journal Syste

### Contribute Changes

To contribute changes you will need to install this theme from the `master` branch of this repository.
To contribute changes you will need to install this theme from the `main` branch of this repository.

1. `git clone https://github.com/pkp/immersion.git`.
2. Move to the theme's root folder: `cd immersion`.
3. Make sure that [npm](https://www.npmjs.com/get-npm) and [Gulp](https://gulpjs.com/) are installed.
4. Resolve dependencies: `npm install`. Gulp config file is inside a theme root folder `gulpfile.js`.
5. To compile external SCSS, concatenate styles and minify: `gulp sass`. The result CSS path is `resources/dist/app.min.css`. The theme's own styles are compiled automatically by OJS's theme API.
6. To concatenate and minify javascript: `gulp scripts` and `gulp compress`. The result Javascript file path is `resources/dist/app.min.js`. Run `gulp watch` to view javascript changes inside `resources/js` folder in real time.
7. To compile and minify all at once: `gulp compileAll`.
7. To compile and minify all at once: `gulp build`.
8. Copy the plugin's folder to `plugins/themes` directory starting from the OJS installation root folder.
9. Login into the OJS admin dashboard, activate the plugin and enable the theme.

Note that the master branch may contain code that will not be shipped to the stable release.
Note that the main branch may contain code that will not be shipped to the stable release.

## Contributors
Immersion theme was designed and developed by Sophy Ouch ([@sssoz](https://github.com/sssoz)), Vitaliy Bezsheiko ([@Vitaliy-1](https://github.com/Vitaliy-1)), John Willinsky, and Kevin Stranack.
Expand All @@ -50,5 +50,3 @@ For technical question regarding the theme (bugs, enhancements, etc.), please op
This theme is released under the GPL license.

The Roboto font is distributed under the terms of the [Apache License, 2.0](http://www.apache.org/licenses/LICENSE-2.0). The Spectral font is distributed under the terms of the [Open Font License](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL).


11 changes: 11 additions & 0 deletions exclusions.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
immersion/.gitignore
immersion/.github
immersion/cypress
immersion/exclusions.txt
immersion/gulpfile.js
immersion/node_modules
immersion/package.json
immersion/package-lock.json
immersion/resources/js
immersion/resources/dist/app.js
immersion/resources/dist/app-debug.js
2 changes: 1 addition & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ gulp.task('compress', function() {
.pipe(gulp.dest('resources/dist'));
});

gulp.task('compileAll', gulp.series('sass', 'scripts', 'compress'));
gulp.task('build', gulp.series('sass', 'scripts', 'compress'));

gulp.task('watch', function() {
return gulp.watch('resources/js/**/*.js', gulp.series('scripts', 'compress'));
Expand Down

0 comments on commit c4bd2d3

Please sign in to comment.