Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ NEXT_PUBLIC_FIREBASE_STORAGE_BUKCET="some-project.firebasestorage.app"
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID="00000000000"
NEXT_PUBLIC_FIREBASE_APP_ID="app-id"

# Original template from Avalia/Hotay
# Original template from Avalia
NEXT_PUBLIC_SPREADSHEET_TEMPLATE_ID="1SfimzvUWXehgbfLYS_Pi2lABrWlWqjeU8_gX3xu2TXI"

# Link for Evaluators feedback about the project
Expand Down
39 changes: 10 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,27 @@ As a contributor, here's an overview of things to learn and ways to get involved
## Code of Conduct

Help us keep Avalia open and inclusive.
Please read and follow our [Code of Conduct][https://github.com/hotaydev/avalia/blob/main/.github/CODE_OF_CONDUCT.md].
Please read and follow our [Code of Conduct][https://github.com/TaylorHo/avalia/blob/main/.github/CODE_OF_CONDUCT.md].

## How can I help?

There are many ways to help. Here are some ways to contribute without coding:

- You can help others in our [GitHub Discussions page][https://github.com/hotaydev/avalia/discussions/categories/q-a].
- You can [contribute to the official documentation](https://github.com/hotaydev/avalia/tree/main/docs).
- You can verify bugs in the [issues tab][https://github.com/hotaydev/avalia/issues] and mention the steps to reproduce them. This helps the core team receive more reports so we can fix higher priority bugs.
- You can help others in our [GitHub Discussions page][https://github.com/TaylorHo/avalia/discussions/categories/q-a].
- You can [contribute to the official documentation](https://github.com/TaylorHo/avalia/tree/main/docs).
- You can verify bugs in the [issues tab][https://github.com/TaylorHo/avalia/issues] and mention the steps to reproduce them. This helps the core team receive more reports so we can fix higher priority bugs.

For ways to help with code, read the next section.

### Code Contributions

For contributors who want to help with code, we have a list of [good first issues](https://github.com/hotaydev/avalia/labels/good%20first%20issue) to help you get started.
For contributors who want to help with code, we have a list of [good first issues](https://github.com/TaylorHo/avalia/labels/good%20first%20issue) to help you get started.
These are beginner-friendly issues that don't require advanced knowledge of the codebase. We encourage new contributors to start with these issues and gradually move on to more challenging tasks.

## Have a Question or Problem?

Please don't open issues for general support questions, as we want to keep the GitHub issues section for bug reports and feature requests.
Instead, we recommend using our [GitHub Discussions tab][https://github.com/hotaydev/avalia/discussions/categories/q-a] for support-related questions.
Instead, we recommend using our [GitHub Discussions tab][https://github.com/TaylorHo/avalia/discussions/categories/q-a] for support-related questions.

These channels are a much better place to ask questions because:

Expand All @@ -50,7 +50,7 @@ If you want to discuss your issue in real-time, you can contact [@TaylorHo][http

## Found a Bug?

If you find a bug, you can help us by [opening an issue](#opening-an-issue) in our [GitHub Repository][https://github.com/hotaydev/avalia].
If you find a bug, you can help us by [opening an issue](#opening-an-issue) in our [GitHub Repository][https://github.com/TaylorHo/avalia].
Even better, you can [submit a Pull Request](#submitting-a-pull-request-pr) with a fix.

## Missing a Feature?
Expand All @@ -61,22 +61,20 @@ It's always beneficial to engage in discussions about a feature before starting

## Opening an Issue

Before opening an Issue, please search the [issues tab][https://github.com/hotaydev/avalia/issues]. An issue for your situation may already exist, and the discussion may inform you about readily available alternative solutions.
Before opening an Issue, please search the [issues tab][https://github.com/TaylorHo/avalia/issues]. An issue for your situation may already exist, and the discussion may inform you about readily available alternative solutions.

To submit an issue, [fill out the issue using a template][https://github.com/hotaydev/avalia/issues/new]. Please only log one issue at a time and don't list multiple bugs in the same issue.
To submit an issue, [fill out the issue using a template][https://github.com/TaylorHo/avalia/issues/new]. Please only log one issue at a time and don't list multiple bugs in the same issue.

## Submitting a Pull Request (PR)

Your PR should be opened **from your branch, from your fork, directly to the main branch**. We manage versions by publishing a release and a tag here on GitHub.

Before working on your pull request, please check the following:

1. Search [GitHub][https://github.com/hotaydev/avalia/pulls] for related PRs that might affect your submission.
1. Search [GitHub][https://github.com/TaylorHo/avalia/pulls] for related PRs that might affect your submission.

2. Make sure there is an issue that describes the problem you're fixing or the behavior and design of the feature you'd like to add.

3. Please sign our [Contributor License Agreement (CLA)](#sign-the-cla). We cannot accept code without a signed CLA.

After doing this, you're ready to work on your PR! To create a PR, fork this repository and work on it. Once you include some code in your fork, you can open a PR to the Avalia repository.

For more information, you can follow this [GitHub guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
Expand Down Expand Up @@ -114,23 +112,6 @@ When submitting a Pull Request (PR) or waiting for subsequent review, follow the
- To run avalia locally, just clone this repository, run `npm install`, and run `npm run dev` to start the project. Remember to fill in the environment variables file, `.env.local`.
- To run the documentation, go to the `/docs` folder and run `npm run dev` there.

### Sign the CLA

Please sign our Contributor License Agreement (CLA) before submitting pull requests. For any code changes to be accepted, the CLA must be signed. We promise it's a quick process!

We have a CLA only to be able to use community contributions commercially, aiming to license avalia for companies and large teams. This way, we can financially support the project's development.

[You can view and sign our CLA here][https://cla-assistant.io/hotaydev/avalia].

If you have more than one GitHub account or multiple email addresses associated with a single GitHub account, you must sign the CLA using the primary email address of the GitHub account used to author commits and submit pull requests.

The following documents may help you resolve issues with GitHub accounts and multiple email addresses:

- <https://help.github.com/articles/setting-your-commit-email-address-in-git/>
- <https://stackoverflow.com/questions/37245303/what-does-usera-committed-with-userb-13-days-ago-on-github-mean>
- <https://help.github.com/articles/about-commit-email-addresses/>
- <https://help.github.com/articles/blocking-command-line-pushes-that-expose-your-personal-email-address/>

## Thank You

Your contributions to open source, big or small, make projects like this possible. Thank you for taking the time to contribute.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ GNU AFFERO GENERAL PUBLIC LICENSE

Version 3, 19 November 2007

Copyright (C) 2025 Hotay
Copyright (C) 2025 Taylor Hoffmann <taylor@hoffmann.io>

Everyone is permitted to copy and distribute verbatim copies of
this license document, but changing it is not allowed.
Expand Down
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
<div align="center"><img align="center" src="https://raw.githubusercontent.com/hotaydev/avalia/main/.github/images/avalia-title.png" alt="Avalia Logo" /></div>
<div align="center"><img align="center" src="https://raw.githubusercontent.com/TaylorHo/avalia/main/.github/images/avalia-title.png" alt="Avalia Logo" /></div>

---

<h1 align="center">Avalia</h1>
<h4 align="center">System for evaluating projects in Scientific Initiation Fairs.<br/>Free and Open Source.</h4>

<div align="center"><a href="https://avalia.hotay.dev/">🌐 Access online</a></div>
<div align="center"><a href="https://avalia.hoffmann.io/">🌐 Access online</a></div>
&nbsp;

<div align="center">
<a href="https://github.com/sponsors/hotaydev/"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/hotaydev?label=Sponsors"></a>
<a href="https://github.com/hotaydev/avalia/issues"><img alt="GitHub Issues" src="https://img.shields.io/github/issues/hotaydev/avalia?label=Issues"></a>
<a href="https://github.com/hotaydev/avalia?tab=AGPL-3.0-1-ov-file"><img alt="License" src="https://img.shields.io/github/license/hotaydev/avalia?color=blue&label=Licen%C3%A7a"></a>
<a href="https://avalia.hotay.dev/"><img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Favalia.hotay.dev&up_message=online&down_message=offline&label=Plataforma%20Web"></a>
<a href="https://github.com/sponsors/TaylorHo/"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/TaylorHo?label=Sponsors"></a>
<a href="https://github.com/TaylorHo/avalia/issues"><img alt="GitHub Issues" src="https://img.shields.io/github/issues/TaylorHo/avalia?label=Issues"></a>
<a href="https://github.com/TaylorHo/avalia?tab=AGPL-3.0-1-ov-file"><img alt="License" src="https://img.shields.io/github/license/TaylorHo/avalia?color=blue&label=Licen%C3%A7a"></a>
<a href="https://avalia.hoffmann.io/"><img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Favalia.hoffmann.io&up_message=online&down_message=offline&label=Plataforma%20Web"></a>
<a href="https://doi.org/10.5281/zenodo.15392563"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.15392563.svg" alt="DOI"></a>
</div>
&nbsp;

🎉 Welcome to **Avalia**, a free and open-source platform developed by [Hotay](#about-hotay) to facilitate the evaluation process of projects in Scientific Initiation Fairs. Our goal is to provide a simple and accessible tool that supports teachers and evaluators, especially in public schools, bringing more technology to the daily life of the school community.
🎉 Welcome to **Avalia**, a free and open-source platform developed by [Taylor Hoffmann](https://hoffmann.io/) to facilitate the evaluation process of projects in Scientific Initiation Fairs. Our goal is to provide a simple and accessible tool that supports teachers and evaluators, especially in public schools, bringing more technology to the daily life of the school community.

## ✨ Main Features

Expand All @@ -38,21 +38,17 @@ Avalia was created based on five fundamental pillars:

Avalia is an open-source project and is open to contributions. If you wish to contribute to the development, see our [contribution guide](./CONTRIBUTING.md) and follow the guidelines in our [code of conduct](.github/CODE_OF_CONDUCT.md). Any contribution, whether code, documentation, or suggestions, is welcome!

Hotay is here to build a better world, **one free code at a time**.
We are here to build a better world, **one free code at a time**.

## 🛠️ Roadmap

We are continuously improving Avalia. To understand more about what we've done and what's yet to come, check out our [Roadmap](./ROADMAP.md).

## 🌍 About Hotay

**[Hotay](https://www.hotay.dev)** is a Brazilian software development company dedicated exclusively to creating **free software**. With a focus on providing accessible technological tools for diverse communities, including schools and developers, Hotay sustains its projects mainly through donations. We believe that software should be an empowering tool, accessible to everyone, and we are committed to building a better world, **one free code at a time**.

## 📜 License

This project is licensed under the [AGPL-3.0 License](LICENSE) - see the `LICENSE` file for more details.
In summary, this means that this project can be modified and redistributed, as long as the derived application also has its code open under the same license.

---

If you have any questions or wish to provide feedback, feel free to contact us, preferably by opening a [discussion here on GitHub](https://github.com/hotaydev/avalia/discussions). We appreciate your interest in Avalia! 💬
If you have any questions or wish to provide feedback, feel free to contact us, preferably by opening a [discussion here on GitHub](https://github.com/TaylorHo/avalia/discussions). We appreciate your interest in Avalia! 💬
4 changes: 2 additions & 2 deletions docs/docs/en-US/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
},
{
"text": "Contribute",
"link": "https://github.com/hotaydev/avalia"
"link": "https://github.com/TaylorHo/avalia"
}
]
]
7 changes: 1 addition & 6 deletions docs/docs/en-US/guide/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,5 @@
"type": "dir",
"name": "roadmap",
"label": "Roadmap"
},
{
"type": "dir",
"name": "commercial",
"label": "Commercial Usage"
}
]
]
3 changes: 0 additions & 3 deletions docs/docs/en-US/guide/commercial/_meta.json

This file was deleted.

3 changes: 0 additions & 3 deletions docs/docs/en-US/guide/commercial/commercial-usage.mdx

This file was deleted.

6 changes: 1 addition & 5 deletions docs/docs/en-US/guide/introduction/_meta.json
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
[
"general",
"philosophy",
"about-hotay"
]
["general", "philosophy"]
3 changes: 0 additions & 3 deletions docs/docs/en-US/guide/introduction/about-hotay.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docs/en-US/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ hero:
link: /guide/introduction/general
- theme: alt
text: GitHub
link: https://github.com/hotaydev/avalia
link: https://github.com/TaylorHo/avalia
image:
src: /icon.png
alt: Avalia Docs Logo
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/en-US/self-hosted/general/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Quick Start

Page under construction. If you have some experience with code, you can take a look at the [project's GitHub](https://github.com/hotaydev/avalia). It's relatively simple to set up, especially using [Vercel](https://vercel.com/).
Page under construction. If you have some experience with code, you can take a look at the [project's GitHub](https://github.com/TaylorHo/avalia). It's relatively simple to set up, especially using [Vercel](https://vercel.com/).

The template spreadsheets for administration and tradeshow are as follows:

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/pt-BR/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
},
{
"text": "Acessar o Avalia",
"link": "https://avalia.hotay.dev"
"link": "https://avalia.hoffmann.io"
}
]
]
7 changes: 1 addition & 6 deletions docs/docs/pt-BR/guide/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,5 @@
"type": "dir",
"name": "roadmap",
"label": "Roadmap"
},
{
"type": "dir",
"name": "commercial",
"label": "Uso Comercial"
}
]
]
20 changes: 14 additions & 6 deletions docs/docs/pt-BR/guide/administrators/access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ head:
content: Avalia - Sistema para Avaliação de Feiras Científicas
- - meta
- property: og:url
content: https://avalia.hotay.dev/docs
content: https://avalia.hoffmann.io/docs
- - meta
- property: og:image
content: https://avalia.hotay.dev/docs/images/preview.jpg
content: https://avalia.hoffmann.io/docs/images/preview.jpg
---

import { normalizeImagePath } from 'rspress/runtime';
import { normalizeImagePath } from "rspress/runtime";

# Acesso

O acesso à área administrativa do **Avalia** é projetado para ser rápido e sem complicações, eliminando a necessidade de senhas. Atualmente, existem duas formas de login disponíveis para os administradores:

[Página de login administrativo](https://avalia.hotay.dev/admin/login).
[Página de login administrativo](https://avalia.hoffmann.io/admin/login).

### 1. Login com Google

Expand All @@ -28,15 +28,23 @@ Para acessar a plataforma, você pode utilizar sua conta do Google. Este método
Se preferir, você também pode acessar o Avalia através de um **link de login** enviado diretamente para o seu e-mail. Basta clicar no link recebido para entrar na plataforma. Esse método é ideal para quem deseja evitar a integração com outras contas, para quem prefere simplicidade no acesso, ou simplesmente para aqueles que usam e-mails diferentes de @gmail.

&nbsp;
<img src={normalizeImagePath("/images/admin/login.png")} alt="Login administrativo" />

<img
src={normalizeImagePath("/images/admin/login.png")}
alt="Login administrativo"
/>
&nbsp;

### Primeiro Acesso e Criação de uma Feira

Após realizar o primeiro acesso, caso você não tenha sido convidado por outro administrador para participar de uma feira existente, será solicitado que você preencha as informações iniciais sobre a sua feira. Esses dados incluem o **nome da escola** e o **nome da feira** que você deseja criar e administrar. Ao concluir essa etapa, você se torna automaticamente o administrador principal da feira e terá a capacidade de convidar outros usuários para ajudar na administração.

&nbsp;
<img src={normalizeImagePath("/images/admin/config.png")} alt="Dados da feira" />

<img
src={normalizeImagePath("/images/admin/config.png")}
alt="Dados da feira"
/>
&nbsp;

### Importante: Associação de E-mail a uma Feira
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/pt-BR/guide/administrators/admin-users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ head:
content: Avalia - Sistema para Avaliação de Feiras Científicas
- - meta
- property: og:url
content: https://avalia.hotay.dev/docs
content: https://avalia.hoffmann.io/docs
- - meta
- property: og:image
content: https://avalia.hotay.dev/docs/images/preview.jpg
content: https://avalia.hoffmann.io/docs/images/preview.jpg
---

# Usuários Administrativos
Expand All @@ -21,9 +21,9 @@ Como administrador, você pode convidar outros usuários para se juntarem à adm

### Como Enviar o Link de Convite

Após convidar um novo usuário, você verá uma opção na página de **Usuários Administrativos** chamada **"Copiar Link de Convite"**. Esse link é personalizado e permite que o usuário convidado se junte à administração da feira.
Após convidar um novo usuário, você verá uma opção na página de **Usuários Administrativos** chamada **"Copiar Link de Convite"**. Esse link é personalizado e permite que o usuário convidado se junte à administração da feira.

Você pode copiar esse link e enviá-lo diretamente ao usuário via e-mail, WhatsApp ou qualquer outro meio de comunicação. Quando o usuário clicar no link, ele será direcionado para a página de cadastro, onde poderá se cadastrar usando uma conta Google ou via link enviado por e-mail.
Você pode copiar esse link e enviá-lo diretamente ao usuário via e-mail, WhatsApp ou qualquer outro meio de comunicação. Quando o usuário clicar no link, ele será direcionado para a página de cadastro, onde poderá se cadastrar usando uma conta Google ou via link enviado por e-mail.

### Acesso Imediato à Feira

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/pt-BR/guide/administrators/evaluators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ head:
content: Avalia - Sistema para Avaliação de Feiras Científicas
- - meta
- property: og:url
content: https://avalia.hotay.dev/docs
content: https://avalia.hoffmann.io/docs
- - meta
- property: og:image
content: https://avalia.hotay.dev/docs/images/preview.jpg
content: https://avalia.hoffmann.io/docs/images/preview.jpg
---

# Avaliadores
Expand Down
Loading