-
Notifications
You must be signed in to change notification settings - Fork 26
Contributing Guide
Aerial is open source under the MIT License.
If you want to contribute code or other resources to Aerial, we would love the help!
For small changes or minor bug fixes just submit a Pull Request and we'll have a look.
For larger changes create an issue so we can fully discuss the change, coordinate efforts, and help you figure out the existing code before you start working on it.
Aerial is an Electron app and is set up as such. If you have written Node.js before the set up is very similar. To set up your environment you will need the following:
- Javascript IDE (any one will do)
- Node.JS & NPM (latest LTS version, nvm is encouraged)
Simply clone or fork the repo. Open the repo in you IDE to start coding.
All code is written in HTML, CSS, and JavaScript. It should be pretty self-explanatory, but if you have any questions create an issue or discussion.
To test the app, first make sure you have all the node modules installed by running npm install in the project directory. Then run npm start to launch the screen saver. Aerial will then launch in your system tray. You can use the start flags below to test specific pages.
Aerial will launch different windows based on the startup flag you give it. A list of all the built in flags detailed below
| Flag | Window |
|---|---|
| /s | Launches the screen saver in full screen mode |
| /c | Launches the config menu |
| /t | Launches the screen saver in a smaller window with borders |
| /j | Super secret video.JSON editor |
You can also use these additional flags for special options
| Flag | Effect |
|---|---|
| /dt | Automatically opens the dev tools |
| /nq | Prevents the app from closing itself |
All flags work with both the compiled .exe and the npm cml:
aerial.exe /s npm start /c
Want to build Aerial for yourself? First set up dev environment as detailed above.
Then run npm run build to build the installer. It will be placed in /dist in the project directory.
What do you need help with right now?
See the open issues or project board for features we are currently working on. The help wanted tag is a great place to start!
We are especially looking for people to help clean up the UI/UX, add video metadata (see #102), and simply test Aerial.
I don't know how to do any of that! What do I do?
We would still love your help! Create an issue with something you would like to see done and we can help you make it happen. If you think that you might be able to help with something simply ask if your idea would work then we can help you code it!
I'm having an issue and I need help!
Create an issue and we'll get back to you ASAP.