/espoo-dev

Espoo-dev is a learning platform.

Primary LanguageRuby

espoo-dev

Frontend CI (semaphore)

Build Status

Backend CI (Ruby.ci)

rspec

rubocop

simplecov

simplecov

simplecov

Project definion

Espoo-dev is a learning platform. There are three user types:

  • Teacher: Creates Surveys with many Questions
  • Student: Answers the Questions that belongs to a Survey
  • Admin: (only relevant for developers) Can manage everything

Architecture / Modules

  • This repository is a Monorepo, it has 2 folders named backend and frontend
  • backend (Ruby on Rails):
    • Backoffice app (admin panel) : The users (Teacher/Admin) can manage the Surveys, Questions, Options and see the answers/reports
    • API: Used by the Web Client to enable Students to answer Questions that belongs to a Survey
    • Web Client: The users (Student) can answer Questions that belongs to a Survey
  • frontend (Next, React):
    • Web Client: The users (Student) can answer Questions that belongs to a Survey
  • note: We have 2 versions of Web Client, Next/React and Rails

😃 Contributing

Please check CONTRIBUTING.md

✨ Demos

  1. admin
  2. client
  3. credentials

🌎 Community

  1. Slack

Current features

  • API:
    • Login
    • create, index users
    • create, index surveys
    • index roles
  • Backoffice app - rails:
    • Login, Logout
    • Teacher can manage surveys, questions, options
    • Admin manage everything that Teacher plus users, roles, question types, surveys subjects
  • Web Client - react
    • Login, Logout, Register
    • List surveys
  • Web Client - rails
    • Login, Logout, Register
    • List surveys

Next features

  • Free text, image, audio, video questions
  • Free text, image, audio, video answers
  • Answers reports
  • Public surveys
  • Surveys protected by password