Getting started guide.

This commit is contained in:
Mathijs de Bruin 2013-10-28 16:26:44 +01:00
parent ebc3c4cb99
commit 41e384892c

View file

@ -9,8 +9,55 @@ Web-based software to manage a non-profit food coop (product catalog, ordering,
More information about using this software and contributing can be found on the [wiki](https://github.com/foodcoops/foodsoft/wiki).
Install
--------
System requirements
-------------------
* [RVM](https://rvm.io/rvm/install)
* [Ruby 1.9.3](https://www.ruby-lang.org/en/downloads/)
* [Bundler](http://bundler.io/)
Getting started
---------------
1. Install RVM (if you have not done so before):
\curl -L https://get.rvm.io | bash
2. Clone the repository from GitHub:
git clone https://github.com/foodcoops/foodsoft.git
3. Install Ruby dependencies:
bundle install
4. Setup your development environment:
rake foodsoft:setup_development
This will interactively prompt with several questions relating to your
required environment.
5. Start rails by running:
bundle exec rails s
6. Open your favorite browser and open the web application at:
http://localhost:3000/
You might want to watch a
[kitten video](https://www.youtube.com/watch?v=9Iq5yCoHp4o)
while it's loading.
7. Login using the default credentials: `admin/secret`
8. Change the admin password, just in case.
9. Have phun!
Developing
----------
Have a look at [DEVELOPMENT.md](https://github.com/foodcoops/foodsoft/blob/master/doc/DEVELOPMENT.md) (outdated) and the (more recent) [Developing Guidelines](https://github.com/foodcoops/foodsoft/wiki/Developing-Guidelines) page on the wiki.