sumelms/website

Sumé LMS Website and Documentation

About Sumé LMS

Note: This repository contains the Sumé LMS installation script.

Sumé LMS is a modern and open-source learning management system that uses modern technologies to deliver performance and scalability to your learning environment.

• Compatible with SCORM and xAPI (TinCan)
• Flexible and modular
• Open-source and Free
• Fast and modern
• Easy to install and run
• Designed for microservices
• REST API based application
• and more.

Table of Contents

• Prerequisites
• Setup
• Building
• Testing
• Contributing
• Code of Conduct
• Team
• Support
• License

Prerequisites

@TODO

Setup

@TODO

Building

@TODO

Testing

@TODO

Contributing

Thank you for considering contributing to the project. In order to ensure that the Sumé LMS community is welcome to all make sure to read our Contributor Guideline.

Code of Conduct

Would you like to contribute and participate in our communities? Please read our Code of Conduct.

Team

@TODO

Support

@TODO

License

This project is licensed by the Apache License 2.0. For more information check the LICENSE file.

website's Issues

Website responsive

Create a responsive Website

Create the Code of Conduct

Discuss and adopt a code of conduct to define Sumé community standards.
We can describe on the website and link with every Sumé application.

Customize the website footer

Create a footer like in the mockup.

Small usability fixes

Invert the hover effect, keeping it only when the mouse is over the links, for these items:

Also, remove the hover effect from the credits line that is not a link.

Investigate the possibility to improve website structure

Maybe we can simplify the website structure, using the CSS styles provided by the Docusaurus template that we are using. But, I'm not sure how it is gonna work if it is using some CSS framework or what.

We need to figure out:

• Is it using any CSS framework?
• Can we reuse the CSS class available in the template?
• It could help us with the responsive and dark theme?
• How much effort would be necessary to change it?

Create the website

Create the website using Docusaurus 2.

• Create the template mock
• Create the Figma template
• Install and configure Docusaurus 2
• Implement the template designed on Figma

Replace vector and add credits to it

We need to replace some vectors on the page.

To be replaced:

Replace it by:
https://www.freepik.com/free-vector/devices-concept-illustration_5462824.htm#page=1&position=31#&position=31

To be replaced:

Replaced it by:
https://www.freepik.com/free-vector/design-community-concept-illustration_6610841.htm

These are just suggestions. We can use anything from this author, so we don't need to credit multiple people:
https://www.freepik.com/stories

Or if you want to pick up all the vectors from other authors is up to you. Just be sure that we should use the same art style and only one source. :)

Add this to the footer, to give the credits to the images:
<a href="https://www.freepik.com/free-photos-vectors/business">Business vector created by stories - www.freepik.com</a>

Organize the documentation structure

Review Spacing

To review spacing across the site, especially in this section

Autodetect user language

Description

It would be pretty nice if we could detect the browser language or user IP. I don't know which one is the best, and preselect the website language based on this information.

UI Resource

N/A

Aditional information

Maybe we can find some information here: https://v2.docusaurus.io/docs/i18n/introduction

Possible unknowns

• Should we use IP or Browser language?
• Does Docusaurus already support it?

Create a nice README

We need a nice README file. It should explain how to run the project locally, how to contribute, and more.

Section to Sumé Edu

Description

We need to include the section that talks about the Sumé Edu.

UI Resource

Follow the same visual identity.

Aditional information

The texts in Portuguese to the section is:

Title: Sumé Edu
Sutitle: Uma ferramenta de apoio à educação

Content:
Para garantir aos educadores e alunos uma compreensão ampla e detalhada sobre o que é a Sumé e o Sumé LMS e como eles podem auxiliar no desenvolvimento e na implementação das aulas virtuais, criamos o Sumé Edu (Manual do Educador). Seu objetivo é ajudar e auxiliar os educadores a remodelar e a adaptar o que é ensinado em sala de aula física para a sala de aula virtual, tentando, em todos os aspectos, não perder a qualidade necessária à construção do conhecimento.

Assim como toda a plataforma Sumé, o manual também é um produto de construção coletiva e está aberto à colaboração de todos. Para acompanhar o desenvolvimento do conteúdo e entender como ajudar neste processo, acesse o manual e confira!

Button text: Vistar o projeto
Button link: https://edu.sumelms.com

Possible unknowns

• Where is the best place to put it?
• How will it look like?

Review text content

The texts present in the text areas are temporary, it is necessary to add "permanent content" in these areas.