Giter VIP home page Giter VIP logo

devcamp-portfolio's Introduction

Devcamp Portfolio

typescript-action status

About

This repo has been created to document my progress on the Dissecting Ruby on Rails 5 course.

Despite the course being based on rails 5, I built this application in Rails 6 with a modernized approach. I took the course as a refresher on the framework to accommodate my new job role. Regardless of its age the course still covers a mountain of useful information regarding best practices and the Rails ecosystem.

Deployment

Deployment of the app was done via Heroku, using the Redistogo addon.

Visit the app here

Course completion: 100%

Features

  • Login/Sign Up with varying admin/user permissions
  • CRUD Blogs
  • CRUD Portfolios
  • Drag and drop portfolio cards
  • AWS Image Uploader
  • Live Twitter Feed
  • Live Action Cable Commenting
  • Categorization of blogs and portfolios
  • Gravatar profile images

How to run

Note

The following environment variables will need to be added to a .env file in the projects root directory, the project requires an AWS S3 bucket and Twitter API keys. For more information on how to generate your own keys visit:

Twitter API Docs

AWS S3 Docs

Your .env will need to be formatted as follows:

S3_BUCKET_NAME=your-bucket-name
AWS_ACCESS_KEY_ID=XXXXXXXXXXXXXXXXXXXX
AWS_SECRET_ACCESS_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
AWS_REGION=your-region-#

TWITTER_CONSUMER_KEY=XXXXXXXXXXXXXXXXXXXXXXXXX
TWITTER_CONSUMER_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWITTER_ACCESS_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWITTER_ACCESS_TOKEN_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Your cable.yml file will need the production URL changed to the following if your running the project locally.

<%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %> 

Before running the project ensure you run

rails db:setup

Followed by

bundle install 

Run any pending migrations with

rails db:migrate 

Optionally run

rails db:seed 

Install Yarn dependencies

yarn install

Finally run

rails s

Testing

Testing for models has been added using RSpec, these can be found in the spec directory.

To run tests use

bundle exec rspec

For Capybara feature tests to run ensure your system has Google Chrome installed, alternatively update Capybara's default driver to use one of your choosing. This can be done in the feature test specs found in the spec/features directory.

devcamp-portfolio's People

Contributors

steven-klavins avatar

Watchers

James Cloos 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.