Oblyk is an open-source community website dedicated to climbing. It aims to build a large open-data database of cliffs, routes and climbing gyms in France and around the world that can be freely consulted via an API. Climbers can also use this tool to rate their crosses or find climbing partners.
This repository is the API part of Oblyk project.
For front app, go here : oblyk-app
- ruby 2.6.5
- bundle >= 2.0.0
- docker >= 20.10
- docker-compose >= 1.25
# Clone project
git clone git@github.com:oblyk/oblyk-api.git
# Go to project folder
cd oblyk-api
# Install gem
bundle
# Copy example local_env.yml
cp config/local_env.example.yml config/local_env.yml
# Up docker
docker-compose up -d
# Create oblyk_development database
bundle exec rails db:setupbundle exec rails sGo to localhost:3000
Enjoy !
First open rails console
bundle exec rails cEnd create your organization
my_organization = Organization.new name: 'My Awesome Organization', email: 'my@email.com', api_usage_type: 'personal'
my_organization.save
my_organization.api_access_token
# => vvPpFZhg....
# You can use this token in HttpApiAccessToken headerSidekiq si job system, start it to unstack the background tasks
bundle exec sidekiqGo to localhost:3000 to see the monitor.
Sidekiq user and password is configured in config/local_env.yml
bundle exec rake search_tasks:import["Crag"]
bundle exec rake search_tasks:import["CragRoute"]
bundle exec rake search_tasks:import["GuideBookPaper"]
bundle exec rake search_tasks:import["Area"]
bundle exec rake search_tasks:import["Gym"]
bundle exec rake search_tasks:import["Word"]
bundle exec rake search_tasks:import["User"](sidekiq must be started)
bundle exec rake create_feeds:for_model["Alert"]
bundle exec rake create_feeds:for_model["Gym"]
bundle exec rake create_feeds:for_model["GuideBookPaper"]
bundle exec rake create_feeds:for_model["GuideBookPdf"]
bundle exec rake create_feeds:for_model["GuideBookWeb"]
bundle exec rake create_feeds:for_model["Word"]
bundle exec rake create_feeds:for_model["Video"]
bundle exec rake create_feeds:for_model["Photo"]
bundle exec rake create_feeds:for_model["AscentCragRoute"]
bundle exec rake create_feeds:for_model["Article"]
bundle exec rake create_feeds:for_model["Crag"]
bundle exec rake create_feeds:for_model["CragRoute"]RAILS_ENV=test rails db:migrate # if necessary
bundle exec rake docs:generate