Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zokaibr authored Sep 27, 2017
1 parent e1e5560 commit ad13063
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,30 @@
# README
[ ![Codeship Status for dfmoreto/onebitcode_exchange](https://app.codeship.com/projects/1cc69cf0-83d9-0135-9473-62a24314a0c3/status?branch=master)](https://app.codeship.com/projects/247370)

This README would normally document whatever steps are necessary to get the
application up and running.
# Check Exchange

Things you may want to cover:
This is an app to help people on Currency Conversion.

* Ruby version
On it, it's possible to choose a Currency you want to convert and quantity of it you want.
And it's also possible to request this conversion to be sent to your email.

* System dependencies
![Main view](https://github.com/dfmoreto/onebitcode_exchange/blob/master/public/main_view.png)

* Configuration

* Database creation
## What are we using?

* Database initialization
It's an app built in Ruby on Rails framework and we are using some additional technologies:
- Docker
- Docker compose
- RSpec
- Capybara
- JQuery
- Codeship
- Heroku
- MailGun integrated with Heroku

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)
# How can I run this?

* Deployment instructions
It's very simple.

* ...
You only need to build containers using command `docker-compose build` on root of project and then start your containers with `docker-compose up`

0 comments on commit ad13063

Please sign in to comment.