Giter VIP home page Giter VIP logo

coolpics's Introduction

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 :)

Coolpics! Screenshot

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 [email protected]: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.

coolpics's People

Contributors

omkz avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.