Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Remove dependency "fibers", which does not work with node 16 and above - see https://github.com/laverdet/node-fibers#readme.
Update instructions to setup development environment in README
  • Loading branch information
heapifyman committed Nov 13, 2022
1 parent f2a4c3d commit 8e8698f
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 17 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,27 +102,27 @@ Translations can now be provided over at [transifex](https://www.transifex.com/f
#### Setting up a dev environment

- Clone this repository.
- Install node.js v16 and npm 8
- In the root of your floccus repo, run `npm install && npm install -g gulp`
- Run `gulp` to build
- Find out more on how to develop browser extensions here: <https://extensionworkshop.com/>
- Install the [latest LTS version of node.js](https://nodejs.org/en/download/).
- In the root of your floccus repo, run `npm install`.
- Run `npm run build` to build.
- Find out more on how to develop browser extensions here: <https://extensionworkshop.com/>.

For building the android app you'll need Android Studio

- Open the android/ folder in Android studio and build the App like any other Android app.
- `gulp` and `gulp watch` will push changes to android/ as necessary
- Open the `android/` folder in Android studio and build the App like any other Android app.
- `npm run build` and `npm run watch` will push changes to `android/` as necessary.

#### Building

- `gulp`
- `npm run build`

Run the following to automatically compile changes as you make them:

- `gulp watch`
- `npm run watch`

#### Releasing

- `gulp release`
- `npm run build-release`

## Backers

Expand All @@ -147,5 +147,5 @@ Support this project by becoming a sponsor. Your logo will show up here with a l

## License

(c) Marcel Klehr
(c) Marcel Klehr
MPL-2.0 (see LICENSE.txt)
11 changes: 9 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"scripts": {
"build": "gulp",
"build-release": "gulp release",
"watch": "gulp watch",
"test": "node --unhandled-rejections=strict test/selenium-runner.js"
},
"repository": {
Expand Down Expand Up @@ -44,7 +45,6 @@
"eslint-plugin-standard": "^4.1.0",
"eslint-plugin-vue": "9.x.x",
"execa": "^6.1.0",
"fibers": "^5.0.0",
"file-loader": "^6.2.0",
"gist-client": "^1.1.1",
"gulp": "^4",
Expand Down
8 changes: 4 additions & 4 deletions webpack.common.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ module.exports = {
),
options: path.join(__dirname, 'src', 'entries', 'options.js'),
test: path.join(__dirname, 'src', 'entries', 'test.js'),
native: path.join(__dirname, 'src', 'entries', 'native.js')
native: path.join(__dirname, 'src', 'entries', 'native.js'),
},
optimization: {
splitChunks: { chunks: 'async' }
splitChunks: { chunks: 'async' },
},
output: {
path: path.resolve(__dirname, 'dist', 'js'),
Expand Down Expand Up @@ -45,7 +45,7 @@ module.exports = {
options: {
implementation: require('sass'),
sassOptions: {
fiber: require('fibers'),
fiber: false,
indentedSyntax: true, // optional
},
},
Expand Down Expand Up @@ -73,7 +73,7 @@ module.exports = {
'@babel/preset-env',
{
useBuiltIns: 'usage',
corejs: {version: '3.19', proposals: true},
corejs: { version: '3.19', proposals: true },
shippedProposals: true,
},
],
Expand Down

0 comments on commit 8e8698f

Please sign in to comment.