HackDepot is a service that helps to keep track of things in community-operated places such as hackerspaces.
Though HackDepot has no stable release yet, we're hoping to make the first release as soon as it gets to the point where it fulfills the basic needs of our own hackerspace.
- Install rvm
- Install ruby through RVM
- Go to the project root directory.
- Change database credentials in config/mongoid.yml
- Install the needed gems:
$ bundle install
- Configure the database:
$ rake db:setup
- Start the production server:
$ RAILS_ENV=production rails server
Alternatively you can use hackdepot script that starts the
production service as a daemon.
The application comes with a System V init script etc/init.debian
that allows you to start the HackDepot service on the boot and manage
it with the system tools. Copy the script to /etc/init.d/hackdepot
and adjust it to your needs (see the comments in the script).
Deployment routine is made with Capistrano.
- Deploy to a server using a configured environment. Eg. for
deploying to a production server use
productionenvironment:
$ cap production deploy
- Restart the server:
$ cap production service:restart
will restart the rails application server.
Serving by default implemented with nginx, with custom capistrano
tasks that are generating configuration for nginx to shared
directory on the remote server.
- Generate a nginx configuration by a template:
$ cap production config:upload
will upload all the necessary configuration files to shared, from
you can symlink it to whereever you need on your server.
On the Debian GNU/Linux based distributions the Nginx configuration is
symlinked to /etc/nginx/sites-enabled/hackdepot.conf.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
Please refer the official Git book for details on how to work with Git.
HackDepot is free software; it is distributed under terms of GNU
General Public License as published by the Free Software Foundation,
version 2 of the License. See LICENSE file for the full text of the
license.