Skip to content

Commit

Permalink
Merge pull request rubymem#32 from rubymem/update/readme-with-more-mo…
Browse files Browse the repository at this point in the history
…dern-details

Update/readme with more modern details
  • Loading branch information
bronzdoc authored May 16, 2020
2 parents a7fecbd + c7a51fc commit 9d12665
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 11 deletions.
34 changes: 23 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,37 @@
<img width="250" height="250" src="/logo/rubymem-logo.png">
</p>

[![Build Status](https://travis-ci.org/ombulabs/rubymem.com.svg?branch=master)](https://travis-ci.org/ombulabs/rubymem.com)
[![Build Status](https://travis-ci.org/rubymem/rubymem.com.svg?branch=master)](https://travis-ci.org/rubymem/rubymem.com)

Rails app that powers [rubymem.com](https://rubymem.com).

Pull requests welcome.
This is the Rails app that powers [RubyMem.com](https://RubyMem.com): A website
to submit new reports about gems which have memory leaks. Also, a nice way to
browse existing memory leak advisories.

## Setup

Requires ruby-2.3.1
Requires ruby-2.5 or higher, and Postgres.

./bin/setup

`bundle install`
### Seed

`bundle exec rake db:create db:migrate`
Setup steps will take care of this. If you want to reset your database, you
can remove all records from the database and then call:

### Load advisory database
```ruby
# inside a console
# ./bin/rails console
RubymemImporter.new.import!
```

### Run the tests
`bundle exec rake test`
## Testing

After making changes, make sure you run the test suite:

```
bundle exec rake test
```

## Collaboration

New issues and pull requests are welcome. Read our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) before
submitting an issue or pull request. Thank you! ❤️
3 changes: 3 additions & 0 deletions bin/setup
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ chdir APP_ROOT do
puts "\n== Preparing database =="
system! 'bin/rails db:setup'

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
2 changes: 2 additions & 0 deletions db/seeds.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
#
# movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
# Character.create(name: 'Luke', movie: movies.first)

RubymemImporter.new.import!

0 comments on commit 9d12665

Please sign in to comment.