Skip to content

cassidyhardin/TarjimlyDocs

 
 

Repository files navigation

README

Maintainability

Test Coverage

Build Status

TarjimlyDocs

TarjimlyDocs provides refugees, and aid workers a platform where they can upload documents to be connected with our volunteer translators, who are able to claim translations and perform translations from anywhere around the world.

System dependencies

Our app has been built in Ruby on Rails, with postgrsql and yarn. Please ensure you have the following versions.

ruby 2.6.3

rails 6.0.1

npm 6.13.7

node 13.11.0

npm install [email protected]

yarn 1.21.1

brew install postgresql

brew services start postgresql

To ensure our program will execute correctly ensure you have the right versions, and necessary gems installed, by running the following commands:

rvm gemset empty

gem install bundler

bundle install

Database creation and initialization

After you have the correct installed and started postgresql, install the local database to be able to run our app locally

rake db:create

rake db:migrate

rake db:seed

How to run the test suite

bundle exec rake

Will execute all tests in both cucumber and rspec

cucumber

features tests

rspec

unit testing of features

Accessibility Testing

Accessibility testing can be performed across TarjimlyDocs. We are constantly improving our code to be more accessible to all users!

axe http://localhost:3000/

Rspec Integration testing for accessibility can be found within spec/accessibility_spec.rb

Deployment

Our app is deployed in heroku, and can be accessed at http://tarjimly-docs.herokuapp.com/ however you are also able to run it locally

rails server

Contibutors

Ahmad Jawaid

Cassidy Hardin

Ahmad Ibrahim

Ken Opamurataqongse

Mariam Abughosh

Brandon Scolieri

Arda Sozer

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 47.0%
  • CSS 30.3%
  • HTML 13.4%
  • Gherkin 6.0%
  • JavaScript 3.2%
  • Dockerfile 0.1%