Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create README #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 9 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,15 @@
# README

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

Things you may want to cover:

* Ruby version
# ElePath-Ruby

## System dependencies
Before run ElePath-Ruby you will need to install these dependencies

## Configuration

## Database creation
* **Step 1:** Open database.yml in config folder and set the configurations for the database
* **Step 2:** Run command ```$ rake db:create``` to create the database from the root folder of the project

## Database initialization
* **Step 1:** cd into the project folder
* **Step 2:** Run the command ```$ rails db:migrate```

## How to run the test suite

## Services (job queues, cache servers, search engines, etc.)
- [Docker](https://docs.docker.com/install/)
- [Docker-compose](https://docs.docker.com/compose/install/)

## Deployment instructions
* **Step 1:** Fork form ElePath-Ruby repository and clone it to your desktop
* **Step 2:** Move into the cloned folder
* **Step 3:** Deploy localy by running the command ```$ rails server```
* **Step 3:** Go to localhost:3000 to see the app running
## Run
After install all dependencies you are able to run ElePath-Ruby.

Use the command:
`docker-compose up`

* ...
It will build the container and run it.