Skip to content

Commit

Permalink
Updated setup and readme
Browse files Browse the repository at this point in the history
Signed-off-by: Vanessa Fotso <[email protected]>
  • Loading branch information
vanessuniq committed Oct 2, 2023
1 parent 6956429 commit 441b7b9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 15 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,29 @@ For more details on this release and previous ones, check the [Changelog](https:

[Deploying Vulcan in Production](https://vulcan.mitre.org/docs/)&nbsp;&nbsp;&nbsp;[<img src="public/GitHub-Mark-Light-64px.png#gh-dark-mode-only" width="20"/>](https://pages.github.com/)[<img src="public/GitHub-Mark-64px.png#gh-light-mode-only" width="20"/>](https://pages.github.com/)

## Deployment Dependencies:
## Deployment Dependencies

For Ruby (on Ubuntu):
* Ruby
* `build-essentials`
* Bundler
* `libq-dev`
* nodejs

* Ruby
* `build-essentials`
* Bundler
* `libq-dev`
* nodejs

### Run With Ruby

#### Setup Ruby

1. Install the version of Ruby specified in `.ruby-version`
2. Install postgres and rbenv
3. gem install foreman
4. rbenv install
5. bin/setup
3. Run `gem install foreman`
4. Run `rbenv install`
5. Run `bin/setup`

>> **Note**: `bin/setup` will install the JS dependencies andprepare the database.
>> **Note**: `bin/setup` will install the JS dependencies, prepare the database and load the sample data.
6. Run `rails db:seed` to seed the database.

#### Running with Ruby

Expand All @@ -73,7 +77,6 @@ For testing purposes in the development environment, you can use the following c
1. Stop Vulcan by doing `ctrl + c`
2. Stop the postgres server


## Configuration

See `docker-compose.yml` for container configuration options.
Expand Down Expand Up @@ -132,4 +135,3 @@ This software was produced for the U. S. Government under Contract Number HHSM-5
No other use other than that granted to the U. S. Government, or to those acting on behalf of the U. S. Government under that Clause is authorized without the express written permission of The MITRE Corporation.

For further information, please contact The MITRE Corporation, Contracts Management Office, 7515 Colshire Drive, McLean, VA 22102-7539, (703) 983-6000.

3 changes: 0 additions & 3 deletions bin/setup
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ FileUtils.chdir APP_ROOT do
puts "\n== Preparing database =="
system! 'bin/rails db:create db:schema:load'

puts "\n== Seeding database =="
system! 'bin/rails db:seed'

puts "\n== Removing old logs and tempfiles =="
system! 'bin/rails log:clear tmp:clear'

Expand Down

0 comments on commit 441b7b9

Please sign in to comment.