A book uploader bot that transfers documents from public libraries such as Google Books, Punjab Digital Library and Trove Digital Library to Internet Archive. Built for Wikimedia Tool Labs. Check out BUB2 on Toolforge!

• Getting Started
  • Prerequisites
  • Local setup
    • Clone the repo
    • Set environment variables
  • Run Redis server
    • Start the server
• Example
• Contributing
• Request to Contribute
• Keep Supporting
• License

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

• Node.JS ( check for installation with npm -v and node -v on terminal )
• Redis

• Clone the repository git clone https://github.com/coderwassananmol/BUB2
• Navigate to the project directory on the terminal: cd BUB2.
• For developers, checkout to develop branch: git checkout develop
• Run npm install

Rename .env.example to .env. Then, to fill the credentials,

• Make an account on archive.org.
• Go to https://archive.org/account/s3.php . Generate the access and secret keys and fill them in the .env file in the corresponding fields.
• Go to Google Developers console. Make a new project to run the app. In that Google Developers project, search for 'Books API' in the Google API console, then enable the API for the project, then generate the API keys, and then copy and paste the API key in the GB_Key field.
• Fill the redishost field. If it's hosted locally, enter 127.0.0.1, which is the default localhost.
• Fill the redisport field with 6379, which is the default port number for redis.

• Refer to Redis for download and setup documentation

• Run npm run dev for development and npm run start for production.
• Open your browser and navigate to http://localhost:5000

Please read CONTRIBUTING.md for information on how to contribute to BUB2.

1. Fork the repository.
2. Clone the repository to your local system by using the command : git clone "https://github.com/<YOUR_USERNAME>/BUB2".
3. The issues are maintained on Phabricator.
4. Assign an issue to yourself from Phabricator.
5. Create a new branch and start working on the issue locally.
6. Create a PULL REQUEST to merge your branch with the main branch and mention the Phab task in the description.
7. The issue will be considered closed and resolved once the PR is accepted. Please read CONTRIBUTING.md for information on how to contribute to BUB2.

We actively welcome pull requests. Learn how to contribute.

There was no Node.js wrapper available for Internet Archive, so I decided to write the Node implementation to upload books to Internet Archive. If you like this repository, show your support by starring the project. Cheers!

Please read license for more information.