Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc and license files #137

Merged
merged 12 commits into from
May 14, 2024
15 changes: 0 additions & 15 deletions COPYING

This file was deleted.

49 changes: 4 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
PuzzleTime is an open source time tracking and resource planning web application for SMEs.

![Rails Unit Tests](https://github.com/puzzle/puzzletime/workflows/Rails%20Unit%20Tests/badge.svg)
[![GitHub](https://img.shields.io/github/license/puzzle/puzzletime)](https://github.com/puzzle/puzzletime/blob/master/LICENSE)

## Development

Expand All @@ -15,52 +16,10 @@ directory:
rails db:setup # prepare database
rails server # start the rails server

A more detailed development documentation in German can be found in [doc/development](doc/development/README.md). This is where you also find some [Deployment](doc/development/03_deployment.md) instructions

## Heroku

The current master branch needs to be modified slightly for heroku. To achieve this we create a new branch

git checkout -b heroku_setup

Then we make the require changes for Memcache and Sendfile to [production.rb](config/environments/production.rb)

config.action_dispatch.x_sendfile_header = nil

config.cache_store = :mem_cache_store,
(ENV["MEMCACHIER_SERVERS"] || "").split(","),
{:username => ENV["MEMCACHIER_USERNAME"],
:password => ENV["MEMCACHIER_PASSWORD"],
:failover => true,
:socket_timeout => 1.5,
:socket_failure_delay => 0.2,
:down_retry_delay => 60
}

Then we commit these changes to our branch

git commit -am 'Changes for heroku'

Now we can deploy with these modifications to heroku

heroku create
git push heroku heroku_setup:master

heroku config:set RAILS_SERVE_STATIC_FILES=true
heroku run rails assets:precompile

heroku addons:create memcachier:dev

heroku run rails db:migrate
heroku run 'ln -s /app/db/seeds/development /app/db/seeds/production && rails db:seed'
heroku restart
heroku open

Then login using (username: mw, password: a) as credentials

A more detailed development documentation in German can be found in [doc/development](doc/development/README.md). This is where you also find some [Deployment](doc/development/02_deployment.md) instructions

## License

PuzzleTime is released under the GNU Affero General Public License.
Copyright 2006-2017 by [Puzzle ITC GmbH](http://puzzle.ch).
See COPYING for more details.
Copyright 2006-2024 by [Puzzle ITC GmbH](http://puzzle.ch).
See [LICENSE](LICENSE) for more details.