Skip to content
This repository was archived by the owner on Mar 20, 2018. It is now read-only.

Commit dfcab8a

Browse files
committed
Add install/run directions to README
1 parent d8576f3 commit dfcab8a

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,36 @@
11
stix-profile-crudbox
22
====================
33

4-
CRUD utility for STIX profiles
4+
A Ruby-on-Rails web-based CRUD utility for STIX profiles.
5+
6+
7+
Installation
8+
------------
9+
10+
Start off by cloning this repository.
11+
12+
CRUDbox is a Ruby-on-Rails web application. To get started, install Ruby 2.x and Rails. [Ruby Version Manager](http://rvm.io) is a good means to this end.
13+
14+
Once you have done this, `cd` into the root of your clone of this repository. Run the following command to install the RubyGems that CRUDbox uses:
15+
16+
bundle install
17+
18+
Next, set up `secrets.yml` by following steps 1 and 4 found in the Rails documentation [(here)](http://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml) -- the application will not run without this being done properly.
19+
20+
Running CRUDbox
21+
---------------
22+
23+
Start your development server by running the following from your repository root:
24+
25+
rails s
26+
27+
This will start the rails development server running at `localhost:3000`. Full documentation on running the development server can be found [here](http://guides.rubyonrails.org/command_line.html#rails-server).
28+
29+
**Running a production instance is outside the scope of this README.**
30+
31+
Copyright Information
32+
---------------------
533

634
Copyright (c) 2015 - The MITRE Corporation
35+
736
For license information, see the LICENSE.txt file

0 commit comments

Comments
 (0)