2.3 KiB
What is this application
Morning Peak is a modern and OpenSource Web Application. It has been designed to manage clients, bills, and issues for little and medium compagnies.
Summary
1. Installation
1.1. Requirements
- Ruby 2.0 or greater.
- Postgresql server.
1.2. Initialization
In your shell, start by using this script:
cd MorningPeak/
gem install bundler
bundle install
cp config/database.yml.example config/database.yml
edit config/database.yml # Configure your database connection first
rake db:create
rake db:migrate
rake db:seed # will generate default data. Not on production ;)
1.3. First start
When you done with the configuration of the database (editing config/database.yml),
you can run the server by the following command :
rails s # "-b 0.0.0.0 -p 80" to test on internet :)
The server will be accessible via localhost
Default identifiers, generated in the seed:
user> login: admin@jerevedunemaison.com , password: jrdm2015
admin> login: admin@wir.com , password: wir2015
Checkout for rails minidoc for a resume of rails.
2. Contributions
2.1. Contributors
- Arthur Poulet : main developper, upstream (poulet_a)
2.2. How to contribute ?
You can contribute to this project by Merge Request on the gitlab repository here. The best pratices are to create short commits, and short Merge Requests. Respect the git commit nomage convention as possible with:
- title
- description
- concerned issues with "#id"
We accept any kind of work : translations, bug fix, additionnal features, optimizations, documentation, etc.
Don't be afraid !