https://github.com/richardboehme/lexorank-demo

Lexorank Demo Application
https://github.com/richardboehme/lexorank-demo

Last synced: 13 days ago
JSON representation

Lexorank Demo Application

• Host: GitHub
• URL: https://github.com/richardboehme/lexorank-demo
• Owner: richardboehme
• License: mit
• Created: 2021-03-09T11:04:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T06:16:47.000Z (6 months ago)
• Last Synced: 2024-05-18T05:30:33.647Z (6 months ago)
• Language: Ruby
• Homepage: https://lexorank.richardboeh.me
• Size: 2.83 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Lexorank Demo Application

This little Rails App demonstrates the power of the [Lexorank Gem](https://www.github.com/richardboehme/lexorank) and shows how to use it.

You can visit the live demo [here](https://lexorank.richardboeh.me).

## Development

### Setup Application

Install dependencies:

- Ruby Version: 3.3.0

- Yarn (installable using `corepack install`)

- `libmysql-dev`

This project uses MySQL / MariaDB. If you want to you can use the `docker-compose.yml` file to set up a database for you. Just run `docker-compose up -d`.

Otherwise you might have to change the contents of `config/database.yml` to make the application run.

Run the following commands:

```bash

$ yarn install --check-files

$ bundle install

$ rails db:prepare

$ bin/dev

```

You should have the app running by now.

For running tests you may have to install a chromium browser.

### Contributing

Bug reports and pull requests are highly welcomed and appreciated. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).

1. Fork the repository

2. Create your feature branch by branching off of **main** (`git checkout -b my-new-feature`)

3. Make your changes

4. Make sure all tests run successfully (`rails test:all` and `NOJS=1 rails test:all`)

5. Commit your changes (`git commit -am 'Add some feature'`)

6. Push to the branch (`git push origin my-new-feature`)

7. Create a new pull request