Skip to content

Latest commit

 

History

History
74 lines (60 loc) · 2.7 KB

README.md

File metadata and controls

74 lines (60 loc) · 2.7 KB
Raw

Open Space 🚀 📝

A full stack React.js and Ruby on Rails web app aimed to provide a safe space for sharing kind words to folks who need them.
Built with ❤️ and ✨ by Janet Mendez

See it Live: https://open-space-fe.herokuapp.com/

Features

This web app aims to provide users a safe and open space where they can make posts on things that are bothering them. Users can only see posts with topics that they are subscribed to ensure that users have full control of what they want to see. Users can send notes to other user's posts as encouragement. These notes are private and can only be seen by the recipient as well as validated with IBM Watson Tone Analyzer to ensure they are kind words.

Tech Stack

This web app makes use of the following:

Backend

  • Ruby [2.6.1]
  • Rails [~> 5.2.3] - MVC web framework used as an API
  • PostgreSQL [>= 0.18, < 2.0] - Database
  • bcrypt [~> 3.1.7] - Gem for encryption and securing user passwords
  • Figaro - Rails gem for securing API Keys
  • Active Model Serializers - Serializing API routes to JSON
  • JWT - securing tokens
  • IBM Watson - Ruby SDK for IBM Watson
  • Heroku - App deployment

Front End

  • React.js
  • React Router - Declarative Routing
  • SCSS - CSS pre-processor

Prerequisites

Before you begin, ensure you have installed the latest version of:

This web app uses the following API keys from:

Installing

For information on Frontend Installation please click here: Open Space Frontend

Backend Installation:

  • Clone this repo to your local machine git clone <this-repo-url>
  • cd to backend directory
  • run bundle install to install requiered dependencies
  • Ensure you have a JWT Secret Key
  • Add jwt secert key in the /config/application.yml file like so:
jwt_secret_key: 'YOUR_SECRET_KEY'
  • Ensure you have your IBM Watson Credentials
  • Add credentials in the /config/application.yml file like so:
ibm_watson_key: 'IBM_WATSON_KEY'
ibm_watson_version: 'IBM_WATSON_VERSION'
ibm_watson_url: 'IBM_WATSON_URL'
  • Ensure you have PostgreSQL running
  • run rails db:create to create a database locally.
  • run rails db:migrate to create tables into the database.
  • run rails db:seed to create seed data.
  • run rails s to run the server.