shimada-toy-box / kardies

Opensource Dating Website - backend API

An opensource Greek dating website, backend API. Kardies.gr

How to run locally

• bundle install
• Copy .env.example file and paste to .env (Change where necessary)
• bundle exec rake db:setup
• bundle exec puma
• To run tests: bundle exec rspec
• server running on: localhost:3000

With docker

Requirements: Docker && docker-compose

• Copy .env.example file and paste to .env (Enough for tests to run)
• Run the services: docker-compose up
• Build/seed the DB (only once): docker-compose run --rm api rails db:setup
• Run the tests: docker-compose run --rm api rspec
• server running on: localhost:3000

LOGIN

• curl login request example:

curl --request POST \
  --url http://localhost:3000/oauth/token \
  --header 'content-type: application/json' \
  --data '{
	"email": "[email protected]",
	"password": "password",
	"grant_type": "password"
}'

Dependencies/Requirements for manual installation

• Ruby 2.6.3
• Redis (Not required for the dev environment)
• Elastic Search 6.8.2
• Imagemagick
• MySQL
• AWS S3 bucket

Contributing

All Pull Requests are welcome, from a simple typo to a new feature.

• Fork this repo
• Run the tests
• Create a new branch, add your changes with tests when necessary
• Submit a Pull Request

License

GNU AFFERO GENERAL PUBLIC LICENSE