Skip to content

Commit

Permalink
Update README.md (publiclab#8963)
Browse files Browse the repository at this point in the history
  • Loading branch information
TharindaDilshan authored Jan 8, 2021
1 parent b3a9aec commit 24e8324
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,16 @@ For installation, prerequisites include sqlite3 and rvm. [Click here for a compl
* Using **rbenv**: `rbenv install 2.6.6` followed by `rbenv local 2.6.6`
* Install gems with `bundle install --without production mysql` from the rails root folder, to install the gems you'll need, excluding those needed only in production.
6. Run `cp db/schema.rb.example db/schema.rb` to make a copy of `db/schema.rb.example` in `db/schema.rb`.
7. Run `cp config/database.yml.sqlite.example config/database.yml` to make a copy of `config/database.yml.sqlite.example` in `config/database.yml`.
7. You could choose to use mysql2 or sqlite3 as your database
* If mysql2 Run `cp config/database.yml.mysql.example config/database.yml` to make a copy of `config/database.yml.mysql.example` in `config/database.yml`
* If sqlite3, Run `cp config/database.yml.sqlite.example config/database.yml` to make a copy of `config/database.yml.sqlite.example` in `config/database.yml`.
_kindly note if you choose to use sqlite some tests may fail. The project was setup initially to use mysql and some tests are tailored for mysql db. No need for alarm, we are working to fix these and this will not interfere with your development process_
8. Run `rake db:setup` to set up the database
9. Install static assets (like external javascript libraries, fonts) with `yarn install`
10. By default, start rails with `passenger start` from the Rails root and open http://localhost:3000 in a web browser.
(for local SSL work, see [SSL](#ssl-in-development) below)
11. Wheeeee! You're up and running! Log in with test usernames "user", "moderator", or "admin", and password "password".
12. Run `rails test` to confirm that your install is working properly. Or `rails test:system` for system tests.
12. Run `rails test` to confirm that your install is working properly. Or `rails test:system` for system tests. (_if you chose sqlite as your database, some tests may fail, please ignore these we are working to fix these, if your server starts correctly you all are set_)

### Windows Installation

Expand Down

0 comments on commit 24e8324

Please sign in to comment.