Aossie Scholar

A Google Chrome extension which calculates performance-based metrics for researchers from Google Scholar profile.

Install from Chrome Web Store

Prerequisites

• node: v8.10.0
• npm: v6.14.41
• Postgres

Installing on Local Machine

• Fork to get your own copy of the project
• Clone the repo
• cd aossie-scholar/
• python -m venv env
• source env/bin/activate
• pip install -r requirements.txt
• Rename secrets.json.example to secrets.json
• Enter your database credentials in secrets.json
• python manage.py makemigrations
• python manage.py migrate
• python manage.py runserver

Build and load the extension

• npm install
• npm install gulp-cli -g
• Run gulp for workflow automation. Any changes made in the src/ folder will be automatically reflected in a dist/ folder
• In Google Chrome, go to Extensions>Enable Developer Mode(On top-right)>Click on Load Unpacked(On top-left)>Browse to the project directory>Select dist/
• Visit your Google Scholar profile to register

Testing

• For unit testing, run npm run unit-test
• For e2e testing, run npm run ee-test
• For all testing, run npm test

Code linting and formatting

Aossie Scholar uses Prettier + Eslint for code listing and formatting. To check if your code follows the guidelines, run npm run prettier

Note : The project uses Husky, a pre-commit GIT hook which checks if the code follows linting guidelines before commiting. This helps prevent unwanted linting errors in the pipelines.

Documentation

Please read the documentation for details on the functionalities, automation workflow and the unit testing done in the project.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the GNU General Public License - see the LICENSE.md file for details

Support

Join our Gitter to talk to developers of this project.