Cool but simple web-app mobile-compatible to gamify your life and self-improvement https://lifepex.sceptique.eu/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Arthur POULET 71e9d7c745
achievements: improve error on bad form infos
4 weeks ago
config Improve registering new users with default value and redirection to today 2 months ago
documentation doc: add a french user guide 1 month ago
init readme: clarify everything in the doc 1 month ago
public recap: disable the line 'total' by default 4 weeks ago
scripts other: minor script & ci update 4 weeks ago
src achievements: improve error on bad form infos 4 weeks ago
test user_pex: add user pex json api with tests 1 month ago
.drone.yml other: minor script & ci update 4 weeks ago
.env.sample userpex: improve error and fix test databases 4 weeks ago
.gitignore boot: add dotenv to load env variables 1 month ago
Gemfile boot: add dotenv to load env variables 1 month ago
Gemfile.lock boot: add dotenv to load env variables 1 month ago
README.md readme: fix readme 4 weeks ago
Rakefile test: Add basic test framework and POC 1 month ago
config.ru user_pex: add user pex json api with tests 1 month ago

README.md

LifePex

Build Status

Install the software on a server

Install the dependencies

You should have the following systems installed: git ruby 3 AND gems sqlite OR postgresql Git is required to clone the project and fetch the tags in order to expose them in the webapp.

Then make sure you have installed bundler gem install bundler if not already done.

Then install the ruby dependencies.

bundle install

Configuration setup

A sample file contains all the variables you will need in order to start the server. This is the .env.sample file. You should copy it under the name .env.local.

  • LIFEPEX_DB: is an url to your database. It may include a user/password
  • LIFEPEX_BIND: what your socket will listen to (should probably be 127.0.0.1 or 0.0.0.0)
  • LIFEPEX_BASE_URL: base url for the whole app (for local usage you can leave if empty)
  • LIFEPEX_SECRET: you must put randomness in this variable to secure tokens and cookies
  • LIFEPEX_ENV: may be empty, test, or production to avoid showing the stacktrace when there is a bug

Database setup

The recommanded way is simply to init the database you configured with

./init/database.rb

If you have postgresql, you may want to create a specific user/password for this. Since I suck with SGDB administration, this is a sample of what you may do.

TODO: show how to create a simple attribute with full permission on this database

psql -U postgres postgres -c "CREATE USER root WITH PASSWORD 'toor' SUPERUSER;"
psql -U postgres postgres -c "CREATE DATABASE life_pex"
echo LIFEPEX_DB=postgres://root:toor@localhost/life_pex >> .env.local
./init/database.rb

Start

  • configuration: check
  • setup dependencies: check
  • setup database: check

You can simply start the application.

./src/app.rb

Service, update, etc.

You may want to take a look at the scripts/ directory which contains tons of config helper, for nginx, systemd, etc.


recap image today image

Developers

Generate documentation

./init/doc.rb
xdg-open ./public/doc/index.html

Testing

Generate first a specific configuration file

cp .env.local .env.test.local
editor .env.test.local # don't forget to set a new database !!!

Then init the database

LIFEPEX_ENV=test ./init/database.rb

Then if you want to run the test, simply type rake test (you will need the startup env variable to be set first).