alexavlonitis / kardies Goto Github PK

View Code? Open in Web Editor NEW

8.0 2.0 11.0 2.64 MB

Opensource Dating Website - backend API

Home Page: https://kardies.gr

License: GNU Affero General Public License v3.0

Ruby 89.40% HTML 10.34% Dockerfile 0.11% Shell 0.15%

dating rails-api ruby rails api

kardies's Introduction

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

kardies's People

Contributors

Stargazers

Watchers

Forkers

leandroalemao brianw921 eric-kovshovik sathia27 puzzleduck ngsikai shimada-toy-box deeftah hobb7t kenyc838 avosa

kardies's Issues

fix failing tests/build

There were some recent code changes but rspec tests haven't been updated.
We need to fix and/or add specs where necessary to pass the build

Add spec for conversations_controller.rb

Add rspec spec for -> https://github.com/AlexAvlonitis/kardies/blob/master/app/controllers/api/v1/conversations_controller.rb

https://github.com/AlexAvlonitis/kardies/blob/master/spec/controllers/api/v1/users_controller_spec.rb -> for reference

migrate paperclip to active_storage

paperclip has been deprecated

Add controller spec for reports_controller.rb

Add rspec spec for reports_controller file-> https://github.com/AlexAvlonitis/kardies/blob/master/app/controllers/api/v1/reports_controller.rb

spec for reference ->
https://github.com/AlexAvlonitis/kardies/blob/master/spec/controllers/api/v1/users_controller_spec.rb

Add local docker_composer.yml file for easier installation

To install 3rd party service dependencies

Add spec for messages_controller.rb

Add rspec spec for -> https://github.com/AlexAvlonitis/kardies/blob/master/app/controllers/api/v1/messages_controller.rb

https://github.com/AlexAvlonitis/kardies/blob/master/spec/controllers/api/v1/users_controller_spec.rb -> for reference

There is an open issue to fix the failing build/tests, ignore other tests just focus to pass this one.

Add specs for likes_controller_spec.rb

Add rspec spec for https://github.com/AlexAvlonitis/kardies/blob/master/app/controllers/api/v1/likes_controller.rb file.

https://github.com/AlexAvlonitis/kardies/blob/master/spec/controllers/api/v1/users_controller_spec.rb -> for reference

Search upgrade

Make it POST request instead of GET and save search results and maybe display only saved search results on index

fix locales

when greek not to be /gr but in english to be /en

Search

Don't display deleted users on search results

Messaging fix

Don;t allow to create a new conversation if one already exists

Add specs for EmailPreferencesController

add rspec spec for https://github.com/AlexAvlonitis/kardies/blob/master/app/controllers/api/v1/email_preferences_controller.rb

for reference -> https://github.com/AlexAvlonitis/kardies/blob/master/spec/controllers/api/v1/users_controller_spec.rb

Fix notifications

Real time notifications on new likes and new messages

Change logic fb autogenerate username

Change the username generation logic when a user signs up with facebook, scramble it a bit more.

visual notification on new message

on new message display new message

key not found: "S3_BUCKET_NAME"

I'm new to Ruby and BE dev, can you clarify in more details how to run locally this site?

I found error
/Users/dmozmanyan/Downloads/kardies-master/config/environments/development.rb:6:in `fetch': key not found: "S3_BUCKET_NAME" (KeyError)
While installing command 'bundle exec puma'
Can you help me to understand what is the issue?