omkz / coolpics

Coolpics is an open source platform for creating photo-sharing site.

Coolpics!

Coolpics is an open source platform for creating photo-sharing site that allows its users to share pictures on the app, as well as through a variety of other social networking platforms, such as Facebook, Twitter, Tumblr, and etc. It's like 9gag.com :)

Tech Stack

• Ruby 2.7.1
• Ruby on Rails 6.0.3
• PostgreSQL 9.5
• jQuery
• Twitter Bootstrap 3
• Gem:
  • devise | Authentication
  • pg | PostgreSQL library for Ruby
  • carrierwave | Image upload management

Installation

Requirements

Before you get started, the following needs to be installed:

• Ruby. Version 2.7.1 is currently used and we don't guarantee everything works with other versions. If you need multiple versions of Ruby, rbenv is recommended.
• RubyGems
• Bundler: gem install bundler
• Git
• A database. Only PostgreSQL 9.5 has been tested, so we give no guarantees that other databases (e.g. MySQL) work. If you're using OS X and have Homebrew installed, install it with brew install postgresql
• Redis. Version 4.0.9 has been used successfully, but newer versions should work as well. If you're using OS X and have Homebrew installed, install it with brew install redis
• [elasticsearch] (https://www.elastic.co/products/elasticsearch). If you're using OS X and have Homebrew installed, install it with brew install elasticsearch
• Imagemagick. If you're using OS X and have Homebrew installed, install it with brew install imagemagick

Setting up the development environment

1. Get the code. Clone this git repository:

git clone git://github.com/omkz/coolpics.git
cd coolpics

1. Install the required gems by running the following command in the project root directory:

bundle install

1. Create and initialize the database:

bundle exec rake db:migrate

1. Start the development server:

rails s

Setting up the development environment using Docker (BETA)

Our docker implementation is incomplete and may not work smoothly. Please kindly report any issues and any contribution is welcomed!

1. Install docker and docker-compose
2. git clone [e-mail]:omkz/coolpics.git
3. run docker-compose build
4. run docker-compose run web rails db:setup
5. run docker-compose up
6. That's it! Navigate to localhost:3000

If you want to contribute

The best way to contribute is to do one of the following :

• Creating tests
• Refactoring
• Coding features
• Correcting logged issues
• Correcting my English! (I'm an Indonesian, so don't hesitate to fix my sentences or whole paragraphs.)

License

Coolpics is open source under the MIT license. See LICENSE for details.