Getting Started - Contributing

So, you'd like to contribute to this project?

We're excited to have you in the team! We'll give you a quick introduction on contributing to this project.

Development happens on Github. Fork the project and start editing! You may want to clone the repo locally. To do this, run the following commands (omit the --recursive for a minimal checkout):

                        
git clone --recursive https://github.com/impress/impress.js
cd impress.js
                        
                    

Once you have made your changes, we expect you to run the following commands for testing:

                        
npm i
npm run all
                        
                    

This will build the impress.js file, as well as the impress.min.js file which currently is not included in the repository. It will also build the website and run some tests to make sure your code follows our code guidelines.

Repository structure

• /website: This folder contains all the source code for the impress.js website.
• website/demo/index.html This is the official impress.js demo, showcasing all of the features of the original impress.js, as well as some new plugins as we add them. As already mentioned, this file is well commented and acts as the official tutorial.
• website/demo/examples/ Contains several demos showcasing additional features available. Classic Slides is a simple demo that you can use as template if you want to create very simple, rectangular, PowerPoint-like presentations.
• src/ The main file is src/impress.js. Additional functionality is implemented as plugins in src/plugins/. See src/plugins/README.md for information about the plugin API and how to write plugins.
• test/ Contains QUnit and Syn libraries that we use for writing tests, as well as some test coverage for core functionality. (Yes, more tests are much welcome.) Tests for plugins are in the directory of each plugin.
• js/ Contains js/impress.js, which contains a concatenation of the core `src/impress.js` and all the plugins. Traditionally this is the file that you'll link to in a browser. In fact both the demo and test files do exactly that.
• css: Contains a CSS file used by the demo. This file is not required for using impress.js in your own presentations. Impress.js creates the CSS it needs dynamically.
• extras/ contains plugins that for various reasons aren't enabled by default. You have to explicitly add them with their own `script` element to use them.
• build.js Simple build file that creates `js/impress.js`. It also creates a minified version `impress.min.js`, but that one is not included in the github repository.
• package.js An NPM package specification. This was mainly added so you can easily install buildify and run `node build.js`. Other than the build process, which is really just doing roughly `cat src/impress.js src/plugins/*/*.js > js/impress.js`, and testing, `impress.js` itself doesn't depend on Node or any NPM modules.