Skip to content

Commit

Permalink
Add read me and licence
Browse files Browse the repository at this point in the history
  • Loading branch information
Esteban Arocha committed May 7, 2019
1 parent db72126 commit 05885e2
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 12 deletions.
22 changes: 22 additions & 0 deletions LICENCE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) [2019] [Esteban Arocha Ortuño, Aldo Cervantes Barbosa,
Héctor Ortiz Garza , Alejandro Roiz Walss ]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,38 @@
# README

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

Things you may want to cover:
Install rails 5.2.2.1

* Ruby version
Install postrgress

* System dependencies
Download master branch from https://github.com/EstebanAO/lab-web

* Configuration
Open the terminal and go to the folder of the project

* Database creation
In config file create a file named application.rb with the following information:

* Database initialization
POSTGRES_USER: postgres
WEB-ITESM_DATABASE_PASSWORD: some_password
POSTGRES_HOST: db
REDIS_URL: redis://@redis/0

* How to run the test suite
In terminal:

* Services (job queues, cache servers, search engines, etc.)
Run: rails db:create

* Deployment instructions
Run: rails db:migrate

* ...
Run: rails server

Create a new user according to the users manual

In another terminal run: rails console

In rails console run: u = User.first

In rails console run: u.admin = true

In rails console run: u.save

In rails console run: quit

0 comments on commit 05885e2

Please sign in to comment.