If you've noticed a bug or have a question, search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one!
It is assumed you already have node installed and therefore npm.
To download the full source code and install the Dependencies run the following lines:
git clone https://github.com/alexanderepstein/Sandman
cd Sandman
npm install
cd ..
npm start dev # this will run the application with all of the devtools open
If you get some error and the application wont run try running the following lines and see if that works.
cd Sandman
sudo npm install -g
Right click on the start menu icon at the bottom left and click on the option to open a command prompt in developer mode cd to the Sandman directory then run
npm install -g
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸
Make sure that when you run npm start dev
nothing is clearly wrong with the application.
If you cd into the build folder and run the file labeled with your OS you should be able to build a compiled version of the application. If you are on windows it will build a folder with an exe, on linux it should create 2 .deb files and 1 .rpm file, finally on Mac it should create a dmg. After creating your respective type of the application either install and run it or just run it and see if any errors occur.
First make sure to commit and push your changes to your forked repository. Check to see if there are any conflicts with the main repostior and your fork. If there are none submit the request and give details as to what you changed or added.