mirror of
https://github.com/Evolix/chexpire.git
synced 2024-05-01 16:30:49 +02:00
INSTALL.md improvement
More explanations about database, dependencies and local execution.
This commit is contained in:
parent
747f63bea1
commit
ffe372cec1
16
INSTALL.md
16
INSTALL.md
|
@ -1,12 +1,26 @@
|
|||
# Installation
|
||||
|
||||
## Configuration
|
||||
## Rails configuration
|
||||
|
||||
After cloning this repository, you have to create and edit a few files from example files for your local development configuration :
|
||||
|
||||
- `config/database.yml`
|
||||
- `config/chexpire.yml`
|
||||
- `config/secrets.yml`
|
||||
|
||||
### Database
|
||||
|
||||
You can customize `config/database.yml` for your needs, but by default, Rails is looking for a `chexpire_development` database on localhost.
|
||||
|
||||
### Dependencies
|
||||
|
||||
Execute `# bundle install` to install Ruby dependencies.
|
||||
Execute `# yarn install` to install Javascript dependencies.
|
||||
|
||||
### Local execution
|
||||
|
||||
If you want to start the Rails application manually, with a simple Puma configuration, you have to execute `# bundle exec rails server`.
|
||||
|
||||
## Deployment
|
||||
|
||||
**staging** and **production** environments are preconfigured.
|
||||
|
|
Loading…
Reference in a new issue