Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 2.94 KB

README.md

File metadata and controls

86 lines (60 loc) · 2.94 KB
Raw

CircleCI Maintainability Test Coverage

Meetings Portal

Prototype for Agora Speakers International Portal.

Code / Issues

https://github.com/agoraspeakers/meetings-portal

Requirements

This project is build with Ruby and Ruby on Rails.

  • Ruby version: ruby-2.7.0-preview1
  • Ruby on Rails version: Rails 6.0.0

Usual installation path requires:

  1. install JavaScript engine like nodejs
  2. install ruby
  3. install foreman: gem install foreman
  4. install project dependencies: bundle install
  5. install javascript dependencies: yarn install

Running project

  1. run rails db:prepare to setup or update database
  2. run rails credentials:edit --environment development to set credentials in development environment
  • Fill the file with required credentials listed below: 
    facebook_app_id: your_facebook_app_id
facebook_app_secret: your_facebook_app_secret
    To get these credentials you should:
    1. create Facebook Developer Account
    2. create Facebook App called e.g. "meetings-portal"
    3. set up Facebook Login product with default settings
    4. go to Settings -> Basic, there you can find your App ID and App Secret
  1. OPTIONAL: run rails credentials:edit --environment test to set credentials in test environment
  2. run foreman start to start the rails and the webpack-dev servers
  3. open browser at http://localhost:3000

Linting

Stylesheets

We are using stylelint to check syntax in scss files.

To check if all written styles have correct syntax, please type:

  • yarn stylelint-all

To check if only one file has correct syntax, please type:

  • yarn stylelint path_to_scss_file

JavaScript

We are using ESLint to check syntax in JavaScript files.

To check if all written js files have correct syntax, please type:

  • yarn eslint-all

To check if only one file has correct syntax, please type:

  • yarn eslint path_to_js_file

Facebook data

For now, the Meetings Portal application retrieves only default user's data from facebook.

License

GNU Afero GPL

Contributions

  1. Discuss,
  2. Clone,
  3. Update,
  4. Comment your code,
  5. Write, change, run tests,
  6. Open PR.

Before putting any effort into the project please discuss with other developers to avoid duplicate work or unnecessary efforts.