Pup

v2.x

Cloning & Installing Dependencies

To get started with Pup, clone a copy to your local machine using Git in your terminal.

Once the project has downloaded, cd into the directory and run meteor npm install. This will install all of Pup's NPM dependencies for you. Make sure to do this before starting the server or you will get errors when you boot up.

Notice that here, we default to using meteor npm install as opposed to npm install. This is because meteor npm install uses the version of NPM bundled with Meteor instead of your own computer's global copy of NPM which ensures that any packages with binary dependencies (e.g., bcrypt) are built properly.

If you receive any errors in your terminal when you start up Pup related to meteor npm install, make sure to follow the suggested commands to ensure dependencies are properly installed.

Once your dependencies are installed, just run meteor npm run dev to start the development server at http://localhost:3000.

Don't have Meteor installed?

Meteor is required in order for Pup to run. To get it, head over to this link and follow the instructions for your operating system.


Have Pup installed, running, and wondering what's next? We recommend learning about how Pup organizes React components:

Learn About Organizing React Components

Terminal
git clone https://github.com/cleverbeagle/pup <my-project-name>
Terminal
cd <my-project-name> && meteor npm install
Start the app locally
meteor npm run dev

Keeping Dependencies Up to Date

While Pup's dependencies are updated as often as possible, it's a good practice to update your project's dependencies as frequently as makes sense. This ensures that your app isn't vulnerable to bugs or other issues introduced in Pup's dependencies since the last release.

Atmosphere/Meteor Dependencies

While some Atmosphere (Meteor) dependencies still receive updates, many do not. Regardless, it's good to occasionally run meteor update to bring your packages up to their latest versions.

NPM Dependencies

To keep your NPM dependencies up to date, it's recommended that you utilize the npm-check command line tool. This will tell you which dependencies in your project are out of date and guide you through the process of upgrading your dependencies.