Bem-vindo ao repositório da aplicação Orion, uma ferramenta para auxiliar você em sua jornada de estudos de inglês. Através do método de mineração de frases, o Orion permite que você mergulhe profundamente no idioma, coletando, estudando e aprendendo frases autênticas a partir de palavras novas que você encontra. Com o Orion, o controle do seu próprio aprendizado está em suas mãos, permitindo que você explore o idioma de maneira única e eficaz.
Orion é desenvolvido usando NextJS, uma estrutura de renderização React para aplicações web modernas. A autenticação é simplificada e segura graças ao NextAuth, que permite autenticação rápida através de contas do GitHub e Google.
- NodeJS 18+
- Banco de Dados MongoDB
- Google API e GitHub API keys
-
Clone este repositório para o seu ambiente local.
-
Instale as dependências usando o seguinte comando:
yarn install
- Configure as variáveis de ambiente no arquivo
.envcom as informações necessárias:
NEXTAUTH_SECRET=
NEXTAUTH_URL=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GITHUB_ID=
GITHUB_SECRET=
DATABASE_URL=
ENCRYPTER_PASSWORD=
- Inicie a aplicação usando o comando:
yarn dev
- NextJS 13
- Tailwind CSS
- React Hook Form
- Shadcn (Re-usable components built using Radix UI and Tailwind CSS)
- NextAuth para autenticação
- MongoDB para armazenamento de dados
- Prisma para manipulação do banco de dados
- OpenAI para inteligência artificial
- Zod para validação de dados
Se você deseja contribuir com este projeto, siga estas etapas:
- Faça um fork deste repositório.
- Crie um branch para suas contribuições:
git checkout -b sua-branch. - Implemente suas alterações e adicione documentação, se necessário.
- Envie suas alterações:
git push origin sua-branch. - Abra um pull request neste repositório.
Orion agradece antecipadamente por suas valiosas contribuições!
Este projeto está licenciado sob os termos da Licença Apache 2.0. Para obter mais detalhes, consulte o arquivo LICENSE.