Banco de Itinerários

Sobre o Projeto

O Banco de Itinerários é um projeto de código aberto, que tem como principal objetivo oferecer uma ferramenta colaborativa para auxiliar instituições de ensino, secretarias educacionais e educadores da rede pública e privada por meio do intercâmbio de itinerários formativos e materiais educacionais.

Quem faz?

O Banco de Itinerários é desenvolvido de forma colaborativa. As contribuições são realizadas das mais diversas formas, por profissionais dos mais diversos backgrounds. Sendo que o projeto é idealizado e coordenado pela iniciativa Sumé Edu, parte da Sumé Solutions.

Índice

• Pré-requisitos
• Preparar
• Running
• Testes
• Contribuições
• Código de conduta
• Contribuidores
• Suporte
• Licença de uso

Pré-requisitos

• PHP >= 8.0
• MariaDB >= 10
• NodeJS >= 18.4
• Yarn >= 1.22 or NPM >= 8.12
• Composer >= 2.4

Preparar

1. Clone o repositório:

$ git clone git@github.com:sumesolutions/bancodeitinerarios.git

2. Abra o pasta do projeto no terminal:

$ cd bancodeitinerarios

3. Faça o dowload das dependencias, utilizando o sequinte comando:

$ yarn install
$ composer install

Pode demorar um pouco para baixar todas as dependências, então você está pronto para rodar

Rodar projeto

OK! Agora que você o constrói, você precisa executar o projeto. Isso também deve ser muito fácil.

1. Você precisa configurar sua aplicação:

$ cp .env.example .env
$ php artisan key:generate

Edite o arquivo .env e configure sua conexão com o banco de dados.

@TODO: Adicionar mais informações sobre banco de dados.

2. Rode a migração usando:

$ php artisan migrate

Você pode adicionar --seed ao final do comando migrate para semear o banco de dados com alguns dados falsos.

3. (Em um novo terminal) Inicie o frontend:

$ yarn dev

4. (Em um novo terminal) Rode o backend:

$ php artisan serve

Testes

Todos os testes serão executados com um único comando:

Frontend

$ yarn test

Backend

$ php artisan test

Como fazer contribuições?

Obrigado por considerar contribuir para o projeto!

Para garantir que a comunidade Sumé seja bem-vinda a todos certifiquem-se de ler nossas Diretrizes do Contribuidor.

Código de conduta

Você gostaria de contribuir e participar de nossas comunidades? Leia nosso Código de Conduta.

Contribuidores

Made with contrib.rocks.

Suporte

Comunidade

Você pode entrar em contato conosco ou obter suporte da comunidade em nosso servidor Discord.

Esta é a melhor maneira de encontrar ajuda!

Bugs e solicitação de recursos

Se você encontrou um bug ou tem uma solicitação de recurso, a melhor maneira de fazer isso é opening a issue.

Licença

Este projeto licenciado pela Apache License 2.0. Para mais informações consulte o arquivo LICENSE.

---

with ❤ - SumeEduTeam