Giter Club home page Giter Club logo

yoko-vicky / personal-library-with-rails Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 8.82 MB

This project (Personal Library) was built with Ruby on Rails that allows a user to log in and upload an image that gets automatically tagged using an external image API service called Clarifai.

Home Page: https://bower-test-yokosaka.herokuapp.com/

Ruby 66.23% JavaScript 5.88% SCSS 6.65% HTML 21.23%
ruby-on-rails clarifi s3-bucket heroku carrierwave bootstrap5

personal-library-with-rails's Introduction

Personal Library

Screenshot

About the Project

This project was built with Ruby on Rails that allows a user to login and upload an image that gets automatically tagged using an external image API service called Clarifai.

The base of this application was provided by Lim Choon Yun (Marco) at Bower Bird as a starting point which includes Rails 6, and Bootstrap 5.

Some keynotes

  • Implement Devise as an authentication system
  • Use Amazon S3 for the storage
  • Use an external API, Clarifai for the Image tagging
  • Use Bootstrap to create a responsive layout based on the provided desktop wireframe design
  • Provide basic CRUD for the images and tags
  • Add tests with Rspec, shoulda matchers

A list of commonly used resources that I find helpful is listed in the acknowledgments.

Built With

  • Ruby on Rails
  • Ruby
  • JavaScript
  • JQuery
  • Bootstrap
  • SCSS

Getting Started

To get a local copy up and running follow these simple example steps.

  1. On the project GitHub page, navigate to the main page of the repository.
  2. Under the repository name, locate and click on a green button named Code.
  3. Copy the project URL as displayed.
  4. If you're running the Windows Operating System, open your command prompt. On Linux, Open your terminal.
  5. Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.
  6. Type git clone, and then paste the URL you copied in Step 3.
    e.g. $ git clone https://github.com/yourUsername/yourProjectName
  7. Press Enter. Your local copy will be created.
  8. To install all dependencies and necessary gems, run bundle install
  9. Run rails db:setup
  10. Run rails server to run rails application in your local server
  11. Run rspec to run rspec tests

Author

๐Ÿ‘ค Yoko Saka

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Show your support

Give a โญ๏ธ if you like this project!

Acknowledgements

personal-library-with-rails's People

Stargazers

 avatar  avatar

Watchers

 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.