warlokkz/meteor

Meteor, the JavaScript App Platform

Meteor

Meteor is an ultra-simple environment for building modern web applications.

With Meteor you write apps:

• in pure JavaScript
• that send data over the wire, rather than HTML
• using your choice of popular open-source libraries

Try the getting started tutorial.

Next, read the guide or the reference documentation at http://docs.meteor.com/.

Quick Start

On Windows, simply go to https://www.meteor.com/install and use the Windows installer.

On Linux/macOS, use this line:

curl https://install.meteor.com/ | sh

Create a project:

meteor create try-meteor

Run it:

cd try-meteor
meteor

Slow Start (for developers)

If you want to run on the bleeding edge, or help develop Meteor, you can run Meteor directly from a git checkout.

git clone --recursive git://github.com/meteor/meteor.git
cd meteor

The --recursive flag ensures that submodules will be initialized and updated as part of the cloning process. If you cloned the meteor repository without the --recursive flag, you can equivalently run

git submodule update --init --recursive

in the root of the meteor repository. The typical symptom of not updating submodules will be Error: Depending on unknown package ... when you run most Meteor commands.

If you're the sort of person who likes to build everything from scratch, you can build all the Meteor dependencies (node.js, npm, mongodb, etc) with the provided script. This requires git, a C and C++ compiler, autotools, and scons. If you do not run this script, Meteor will automatically download pre-compiled binaries when you first run it.

# OPTIONAL
./scripts/generate-dev-bundle.sh

Now you can run meteor directly from the checkout (if you did not build the dependency bundle above, this will take a few moments to download a pre-build version).

./meteor --help

From your checkout, you can read the docs locally. The /docs directory is a meteor application, so simply change into the /docs directory and launch the app:

cd docs/
../meteor

You'll then be able to read the docs locally in your browser at http://localhost:3000/.

Note that if you run Meteor from a git checkout, you cannot pin apps to specific Meteor releases or run using different Meteor releases using --release.

Uninstalling Meteor

Aside from a short launcher shell script, Meteor installs itself inside your home directory. To uninstall Meteor, run:

rm -rf ~/.meteor/
sudo rm /usr/local/bin/meteor

On Windows, just run the uninstaller from your Control Panel.

Developer Resources

Building an application with Meteor?

• Announcement list: sign up at http://www.meteor.com/
• Having problems? Ask for help at: http://stackoverflow.com/questions/tagged/meteor
• Discussion forums: https://forums.meteor.com/

Interested in contributing to Meteor?

• Issue tracker: https://github.com/meteor/meteor/issues
• Contribution guidelines: https://github.com/meteor/meteor/tree/devel/Contributing.md

We are hiring! Visit https://www.meteor.com/jobs to learn more about working full-time on the Meteor project.