21
1
Fork 0
mirror of https://github.com/Evolix/chexpire.git synced 2024-05-05 02:05:09 +02:00

Merge pull request #5 from Evolix/pr-install-1

INSTALL.md improvement
This commit is contained in:
Colin Darie 2018-05-31 10:21:59 +02:00 committed by GitHub
commit d4496a6895
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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.