Skip to content

Commit

Permalink
Clean up repo
Browse files Browse the repository at this point in the history
Added ruby version file
Cleaned up Readme
Fixed Faraday warning when running tests
  • Loading branch information
muyjohno committed Nov 22, 2017
1 parent a7b22d4 commit 8f9eb44
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 8 deletions.
1 change: 1 addition & 0 deletions .ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2.4.2
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ group :test do
gem 'factory_girl_rails'
gem 'database_cleaner'
gem 'faker'
gem 'vcr'
gem 'vcr', '~> 3'
gem 'launchy'
end

Expand Down
4 changes: 2 additions & 2 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ GEM
unicorn (5.3.1)
kgio (~> 2.6)
raindrops (~> 0.7)
vcr (2.9.3)
vcr (3.0.3)
websocket-driver (0.6.5)
websocket-extensions (>= 0.1.0)
websocket-extensions (0.1.2)
Expand Down Expand Up @@ -266,7 +266,7 @@ DEPENDENCIES
turbolinks (~> 5)
uglifier (>= 1.3.0)
unicorn
vcr
vcr (~> 3)

BUNDLED WITH
1.16.0
45 changes: 40 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,52 @@
# Cobra

## Setup
## Requirements
To deploy Cobra, you only need Docker Compose and a way of getting the repository onto your server (such as git).

For local development, you will need:
- Ruby 2.4.2 (or a Ruby version manager - e.g. rvm or rbenv - with access to 2.4.2)
- Bundler
```
$ git clone [...]
$ gem install bundler
```
- Postgres
- Git

## Deploy as a web server
- Get the project
```
$ git clone https://github.com/muyjohno/cobra.git
$ cd cobra
```
- Deploy
```
$ docker-compose up
```

## Set up for local development
- Get the project
```
$ git clone https://github.com/muyjohno/cobra.git
$ cd cobra
```
- Install dependencies
```
$ bundle
$ psql postgres
# create user cobra with password '' CREATEDB;
# \q
```
- Set up config files
```
$ cp config/database.example.yml config/database.yml
$ cp config/secrets.example.yml config/secrets.yml
```
- Set up database
```
$ psql postgres
# create user cobra with password '' CREATEDB;
# \q
$ rake db:create db:migrate
```
- Start local server
```
$ rails server
```

Expand Down

0 comments on commit 8f9eb44

Please sign in to comment.