Permalink
Browse files

add screenshot and rework readme

  • Loading branch information...
1 parent 5a790d9 commit f474cae0b389c3844dd12d7e93d9812a756c1260 @netzfisch committed Feb 23, 2014
Showing with 19 additions and 18 deletions.
  1. +19 −18 README.md
  2. BIN app/assets/images/rails.png
  3. BIN app/assets/images/screenshot.png
View
37 README.md
@@ -1,6 +1,6 @@
# TEAM ORGA
-This is the source for a web application to organize closed, not publicly
-groups, secured with a basic authentication. Following features are available:
+This is the source for a **web application to organize closed, not publicly
+groups**, secured with a basic authentication. **Following features** are available:
* register as new user and create a profile,
* create a not publicly group and manage group data,
@@ -14,12 +14,13 @@ groups, secured with a basic authentication. Following features are available:
* backoffice interface.
Originally I started this project for my private sports group as a standalone
-version.
-
-But meanwhile there is also a multitenant version (Software as a Service),
+version. But meanwhile there is also a multitenant software as a service version,
which currently is in private beta. If you want to participate ping me for an invitation.
-## General Information
+### Screenshot
+![TEAM ORGA Website](app/assets/images/screenshot.png)
+
+### Technologys
This project uses [Ruby](http://ruby-lang.org) on
[Rails](http://rubyonrails.org) and twitter
[bootstrap](https://github.com/twitter/bootstrap) for the responsive frontend
@@ -38,7 +39,7 @@ Tracker](https://github.com/netzfisch/teamorga/issues).
Pull-request are welcome.
-## Getting Started
+# Getting Started
### Fork and Clone
There are just a couple of steps to get your private team organisation alive.
Fork this repo at GitHub and than
@@ -54,15 +55,19 @@ Check the specs in the console by
$ guard
### Development
-You don't need to setup a new group with fake users, to see what it feels like.
+You don't need to setup a fake group with users, to see what it feels like.
Just seed the exisiting data
+ $ rake db:drop
+ $ rake db:migrate
$ rake db:seed
- $ foreman start
-We use foreman to start all processes via a 'Procfile' instead doing `$ rails server`.
-Than access the application via http://localhost:5000.
+or as one-liner '$ rake db:drop db:migrate db:seed', which is much faster!
+Than we use foreman to start all processes via a 'Procfile' instead doing `$ rails server`:
+ $ foreman start
+
+Access the application via http://localhost:5000.
Reach the console via `$ foreman run rails console` or `$ rails console`.
### Staging / Production
@@ -79,7 +84,7 @@ $ heroku run rake db:migrate
If erverything runs fine, heroku launches your application and "informs" you
about the live url.
-## Backoffice
+# Backoffice
The application comes with a basic admin interface to manage model data (CRUD):
* Groupdata
@@ -98,19 +103,15 @@ with the "admin role". The first admin needs to be created manual within the con
or via seeding data as described above!
-## Screenshot
-
-*in production, seed data needs to be reworked ;-)*
-
-## Contribution
+# Contribution
1. Fork it
2. Create your feature branch: `$ git checkout -b my-new-feature-branch`
3. Commit your changes `$ git commit -a -m 'add some awesome feature'`
4. Push to the branch `$ git push origin my-new-feature-branch`
5. Create a new pull request
-## License
+# License
TEAM ORGA may be redistributed under the terms specified in the
[LICENSE](LICENSE) file.
View
BIN app/assets/images/rails.png
Deleted file not rendered
View
BIN app/assets/images/screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f474cae

Please sign in to comment.