Skip to content

Commit

Permalink
#117 create exclusions file for plugin release tool (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
kaitlinnewson authored Nov 12, 2024
1 parent c34e83c commit 6ba5550
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,29 @@ An official theme for [OJS 3.1.1+](https://pkp.sfu.ca/ojs/)
Current version classic v.1.1.2

This theme was developed and is maintained by the [Public Knowledge Project](https://pkp.sfu.ca/).

## Installation
The theme can be installed through **Plugin Gallery** in you Open Journal Systems website.
The theme can be installed through **Plugin Gallery** in your Open Journal Systems website.

### Manual installation:
1. Download the [latest release](https://github.com/pkp/classic/releases).
2. Upload through the admin dashboard (**Upload a New Plugin** button on the **Plugins** page) or unpack the archives content inside `plugins/themes` directory starting from OJS web root.
3. Login into the OJS admin dashboard and activate the plugin on the **Plugins** page.
4. Enable the theme in **Website Settings -> Appearence** menu.

### Installation from the master branch (should be used only for development):
### Installation from the main branch (should be used only for development):
1. `git clone https://github.com/pkp/classic.git`.
2. Move to the theme's root folder: `cd classic`.
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/app.min.css`.
6. To concatenate and minify javascript: `gulp scripts` and `gulp compress`. The result Javascript file path is `resources/app.min.js`. Run `gulp watch` to view javascript changes inside `dev_js` folder in real time.
7. Copy the plugin's folder to `plugins/themes` directory starting from the OJS installation root folder.
8. Login into the OJS admin dashboard, activate the plugin and enable the theme.
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 main branch can contain code that will not be shipped to the stable release.

Note that the master branch can contain a code that will not be shipped to the stable release.
## Version Compatibility
* Classic theme version 1.0.0 was tested and compatible with OJS 3.1.1-2.
* Classic theme version 1.0.1 is compatible with OJS 3.1.2.
Expand All @@ -33,10 +36,13 @@ Note that the master branch can contain a code that will not be shipped to the s
* Classic theme version 1.1.0 is compatible with OJS 3.3.0.
* Classic theme version 1.1.1 is compatible with OJS 3.3.0.
* Classic theme version 1.1.2 is compatible with OJS 3.4.0.

## Contributors
Classic theme was designed and developed by Sophy Ouch ([@sssoz](https://github.com/sssoz)), Vitalii Bezsheiko ([@Vitaliy-1](https://github.com/Vitaliy-1)), John Willinsky, and Kevin Stranack.

## Troubleshooting
For technical question regarding the theme (bugs, enhancements, etc.), please open an issue on the plugin's GitHub page. For non-technical question or you are uncertain about the question's category please visit the [PKP Forum](https://forum.pkp.sfu.ca/). Before opening and issue or posting a question on forum please make sure that it wasn't solved before.

## Settings
**Theme Colour |** This theme allows the personalisation of the theme’s main colour. The default colour is a sunflower yellow. If you wish to select your own palette (in Settings > Website), and for best readability, we recommend selecting a tone that provides a good contrast against the black text and borders.

Expand Down
12 changes: 12 additions & 0 deletions exclusions.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
classic/.gitattributes
classic/.gitignore
classic/.github
classic/cypress
classic/dev_js
classic/exclusions.txt
classic/gulpfile.js
classic/node_modules
classic/package.json
classic/package-lock.json
classic/resources/app.js
classic/resources/app-debug.js
2 changes: 2 additions & 0 deletions gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ gulp.task('compress', function() {
.pipe(gulp.dest('resources'));
});

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

gulp.task('watch', function() {
return gulp.watch('dev_js/**/*.js', gulp.series('scripts', 'compress'));
});

0 comments on commit 6ba5550

Please sign in to comment.