Skip to content

IPFC/ipfc-extension

Repository files navigation

Inter Planetary Flash Cards - Extension

Extension available on the Chrome store and the Firefox store

Open source project hosted on github

Quickly make flashcards and highlights from websites and sync them to multiplatform flashcard apps for review

Current build tested in Linux with Node v12.13.1

Built with boilerplate: vue-web-extension

For local environment build change the webpack.config to manifest: path.resolve(__dirname) + '/src/manifest.json', but for docker export use src/ with no prefix /

to install: $ npm install $ npm run build

dev: $ npm run build Build the extension into dist folder for production.

$ npm run build:dev Build the extension into dist folder for development.

$ npm run watch Watch for modifications then run npm run build.

$ npm run watch:dev Watch for modifications then run npm run build:dev. It also enable Hot Module Reloading, thanks to webpack-extension-reloader plugin.

Keep in mind that HMR only works for your background entry.

$ npm run build-zip Build a zip file with the resulting filename format <name>-v<version>.zip, by reading name and version from manifest.json file. Zip file is located in dist-zip folder. this will zip the build dist folder, so make sure you run $ npm run build first

build from docker (currently only for production)

$ docker pull jewcub/ipfc-extension

$ docker run -it jewcub/ipfc-extension you should see Welcome to Node.js v12.16.3. then, to export the generated files back out: in a new terminal $ docker ps find the container ID $ docker export <ID> > ipfc-extension-export.tar the project will be inside the 'app' folder. The zip will be inside dist-zip

About

A browser extension for Inter Planetary Flash Cards

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published