Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dklisiaris/bibliography
Bibliography is a book cataloging web application with social features.
https://github.com/dklisiaris/bibliography
bibliography book-catalog rails ruby social-network
Last synced: 5 days ago
JSON representation
Bibliography is a book cataloging web application with social features.
- Host: GitHub
- URL: https://github.com/dklisiaris/bibliography
- Owner: dklisiaris
- License: gpl-3.0
- Created: 2014-12-24T12:14:59.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T19:47:43.000Z (over 1 year ago)
- Last Synced: 2024-08-02T12:49:02.520Z (3 months ago)
- Topics: bibliography, book-catalog, rails, ruby, social-network
- Language: Ruby
- Homepage:
- Size: 10.9 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - dklisiaris/bibliography - Bibliography is a book cataloging web application with social features. (ruby)
README
# Bibliography - Book Catalog App
[](https://gemnasium.com/dklisiaris/bibliography)
Source code of [BibliographyGR](https://bibliography.gr) Web Application
## Description
Bibliography is a catalog for books and authors of Greek national bibliography which provides a public API to 3rd party book services.
On top of that, libraries or individual users can create collections of their books and users can see where they can loan the book they want.
Some social features are available too.
| | Url |
|------|:------------|
| home | https://github.com/dklisiaris/bibliography |
| bugs | https://github.com/dklisiaris/bibliography/issues |
| docs | http://www.rubydoc.info/github/dklisiaris/bibliography/master |
## Installation
This section's target is to help setup the app and get it running locally.
__Software requirements__
- [Postgres 9.1+ with contrib-packages](http://www.postgresql.org/download/), on Ubuntu check this quick setup [guide](https://gist.github.com/dklisiaris/3c1cd76c28ab86c8ee9c)
- [Redis 2.6+](http://redis.io/download), on Ubuntu check Digital Ocean's [guide](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-redis)
- [Elasticsearch 2+](https://www.elastic.co/downloads/elasticsearch) (Optional)
- [Ruby 2.0+](http://www.ruby-lang.org/en/downloads/) (we recommend 2.0.0-p353 or higher)
- [node](http://nodejs.org) ([on github](https://github.com/joyent/node))
- [bower](https://github.com/bower/bower) (>= 0.10.0) installed with npm
- [imagemagick](https://www.imagemagick.org/script/index.php)
Clone repository
```
git clone https://github.com/dklisiaris/bibliography.git
```
Install depedencies
```ruby
# Go to the root of the app
cd bibliography
# Install ruby gems
bundle install
# Install javascript libraries
rake bower:install
```
All sensitive information is stored in environment variables.
We use dotenv gem to manage these vars.
Create a file named `.env` in the root folder and export environment variables as seen below:
```ruby
# Database credentials in development
export DEVELOPMENT_DATABASE_USERNAME=db_username
export DEVELOPMENT_DATABASE_PASSWORD=db_password
# Database credentials in production
export PRODUCTION_DATABASE_USERNAME=db_username
export PRODUCTION_DATABASE_PASSWORD=db_password
export PRODUCTION_DATABASE_HOST=db_host
export PRODUCTION_DATABASE_PORT=db_port
# Database credentials in staging
export STAGING_DATABASE_USERNAME=db_username
export STAGING_DATABASE_PASSWORD=db_password
export STAGING_DATABASE_HOST=db_host
export STAGING_DATABASE_PORT=db_port
# Elasticsearch host (Usually localhost or some password protected remote url)
export ELASTICSEARCH_URL=http://username:password@host/
# Redis hosts (Usually the same, default is redis://localhost:6379/0)
export REDIS_SERVER_URL=redis://redis.example.com:7372/12
export REDIS_CLIENT_URL=redis://redis.example.com:7372/12
# Mail credentials (we use sendgrid for transactional mails)
export SENDGRID_USERNAME=username
export SENDGRID_PASSWORD=key_provided_by_sendgrid
# Devise secret key (Use rake secret to generate it)
export DEVISE_SECRET_KEY=key_generated_with_rake_secret_command
# Base secret key (Use rake secret to generate it)
export SECRET_KEY_BASE=key_generated_with_rake_secret_command
# Keys for omniauth providers
export FACEBOOK_APP_ID=app_id
export FACEBOOK_APP_SECRET=app_secret
export GOOGLE_CLIENT_ID=client_id
export GOOGLE_CLIENT_SECRET=client_secret
# Keys for performance monitoring tools
export NEWRELIC_LICENSE_KEY=license_key
export SKYLIGHT_TOKEN=secret_token
```
Omniauth and mail service credentials are loaded from `config/secrets.yml`.
The `secrets.yml` is not commited to repositiory. Make sure it has been created
and it looks like this:
```yml
development:
secret_key_base: key_generated_with_rake_secret_command
FACEBOOK_APP_ID: "facebook_app_id"
FACEBOOK_APP_SECRET: "facebook_app_secret"
GOOGLE_CLIENT_ID: "google_client_id"
GOOGLE_CLIENT_SECRET: "google_client_secret"
MAILJET_USERNAME: "mailjet_username"
MAILJET_PASSWORD: "mailjet_password"
test:
secret_key_base: key_generated_with_rake_secret_command
production:
secret_key_base: key_generated_with_rake_secret_command
FACEBOOK_APP_ID: "facebook_app_id"
FACEBOOK_APP_SECRET: "facebook_app_secret"
GOOGLE_CLIENT_ID: "google_client_id"
GOOGLE_CLIENT_SECRET: "google_client_secret"
SKYLIGHT_TOKEN: "skylight_token"
MAILJET_USERNAME: "mailjet_username"
MAILJET_PASSWORD: "mailjet_username"
```
Create and migrate database
```ruby
bundle exec rake db:create
bundle exec rake db:migrate
```
Start rails server (thin) from the root directory of your Rails app
```
rails s
```
Start sidekiq from the root directory of your Rails app
```
bundle exec sidekiq -C config/sidekiq.yml
```
## API Docs
The API documentation is a [slate](https://github.com/tripit/slate) app in `doc/api`.
Do what ever changes you want in api docs and rebuild them by running:
```ruby
# Go to the slate folder
cd doc/api
# Install ruby gems
bundle install
# Build them
bundle exec middleman build
```
The new docs will be available in `public/docs/api` folder.