Developing

Developing and Contributing to this Project

This application is currently built using create-react-app in the node environment. Creating a development environment for this code should be relatively straightforward, but if you run in to any issues, feel free to submit an issue request about it.

Getting Started

1. Install Dependencies

I'm a big fan of using Conda to manage my dependencies for various projects, as it keeps my base OS installation rather clean while allowing me to install custom dependencies for specific projects.

conda create -n pdfbullets
conda activate pdfbullets
conda install git
conda install -c conda-forge nodejs

That's all optional though. If you have git and nodejs/npm installed by other means, you can just go straight into:

git clone https://github.com/AF-VCD/pdf-bullets.git
cd pdf-bullets
npm install

And once that's done, running npm start (which is mapped to react-scripts start in package.json) will start a local server with the application running on it.