Gazelle is a web framework geared towards private BitTorrent trackers. Gazelle is written in Javascript, using the Meteor framework.
Note: This version of Gazelle is under active development.
- The Issues and Milestones contains items that need to be worked on. Check there for a general overview of what needs to be worked on.
- IRC
- #gazelle on irc.what-network.net is the official meteor-gazelle development channel.
- If you are looking for something to work on, ping the Core team using !core .
- For questions and discussions related to the project, new issues may be opened (using the appropriate labels).
- Trello is used for high-level project planning. It is used by the Core team to plan out upcoming ideas and features.
- Fork the repository, and switch to a new branch using
git checkout -b <branch_name>. - Make your changes, and submit a new pull request. Be detailed in the pull request's description.
- Be sure to select the appropriate labels/milestones for your pull request.
- If your pull request applies to an issue, be sure to mention it in the description.
- The new pull request will be broadcasted in #gazelle, and the Core team will review it and leave feedback.
All code follows the Meteor style guide.
After installing Meteor, clone this repository, create a settings.json file based off of the settings template and run meteor run --settings settings.json.
Vagrant allows for a simple installation for a clean development environment. The readme provides detailed instructions for how to set it up. Vagrant is good if you'd like to run meteor-gazelle in a Debian environment.
# one-time setup
curl https://install.meteor.com | /bin/sh
npm install -g spacejam eslint
export PATH="$HOME/.meteor:$PATH"
cp settings.json.template setting.json
# actually run tests
./run_tests.sh
# optionally, just unit tests
./run_tests.sh -t
# optionally, just lint
./run_tests.sh -l
# (optional) install git hook to automatically run test suite before pushing to remote
cd doc/dev/
./install_git_hooks.sh