forked from fixin.me/fixin.me
Specify system requirements and reformat
This commit is contained in:
parent
0dffde414e
commit
dd860eee1e
41
README.md
41
README.md
@ -1,29 +1,42 @@
|
|||||||
# README
|
README
|
||||||
|
======
|
||||||
|
|
||||||
Quantified self
|
Quantified self
|
||||||
|
|
||||||
* Ruby version: 3.1
|
|
||||||
* System dependencies: none
|
Software requirements
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
* Server side:
|
||||||
|
* Ruby version: developed on Ruby 3.x
|
||||||
|
* database with recursive Common Table Expressions (CTE) support, e.g.
|
||||||
|
MySQL >= 8.0, MariaDB >= 10.2.2
|
||||||
|
* for testing: browser as specified in _Client side_ requirements
|
||||||
|
* Client side:
|
||||||
|
* browser supporting below requirements (e.g. Firefox >= 121):
|
||||||
|
* [`import maps`](https://caniuse.com/import-maps)
|
||||||
|
(required by `importmap-rails` gem >= 2.0)
|
||||||
|
* CSS [`:has()` pseudo-class](https://caniuse.com/css-has)
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
## Installation
|
------------
|
||||||
|
|
||||||
git clone https://gitea.michalczyk.pro/fixin.me/fixin.me.git
|
git clone https://gitea.michalczyk.pro/fixin.me/fixin.me.git
|
||||||
bundle config set --local path '.gem'
|
bundle config set --local path '.gem'
|
||||||
bundle install
|
bundle install
|
||||||
|
|
||||||
|
|
||||||
|
Configuration
|
||||||
## Configuration
|
-------------
|
||||||
|
|
||||||
cp -a config/application.rb.dist config/application.rb
|
cp -a config/application.rb.dist config/application.rb
|
||||||
|
|
||||||
Modify configuration settings below `SETUP` comment appropriately.
|
Modify configuration settings below `SETUP` comment appropriately.
|
||||||
|
|
||||||
|
|
||||||
|
Database
|
||||||
## Database
|
--------
|
||||||
|
|
||||||
Grant database user and privileges:
|
Grant database user and privileges:
|
||||||
|
|
||||||
@ -41,9 +54,8 @@ Run database creation and migration tasks:
|
|||||||
RAILS_ENV="production" bundle exec rake db:create db:migrate db:seed
|
RAILS_ENV="production" bundle exec rake db:create db:migrate db:seed
|
||||||
|
|
||||||
|
|
||||||
|
Running
|
||||||
## Running
|
-------
|
||||||
|
|
||||||
|
|
||||||
### Standalone Rails server + Apache proxy
|
### Standalone Rails server + Apache proxy
|
||||||
|
|
||||||
@ -62,10 +74,11 @@ Run server
|
|||||||
|
|
||||||
### Apache mod_passenger
|
### Apache mod_passenger
|
||||||
|
|
||||||
|
TODO: add sample configuration
|
||||||
|
|
||||||
|
|
||||||
## Contributing
|
Contributing
|
||||||
|
------------
|
||||||
|
|
||||||
### Database
|
### Database
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user