Proffy

Proffy copied to clipboard

📝 Conteúdo

Sobre   |    Iniciando   |    Tecnologias Utilizadas   |    Metas de desenvolvimento   |    Como contribuir   |   

🧐 Sobre

Proffy é uma Aplicação feita durante a NWL 2.0 oferecido pela Rocketseat :rocket:.
A aplicação visa estabelecer um contato entre alunos e professores. O professor ao se cadastrar, informa a matéria que deseja dar aula, os dias disponíveis e horários. Após isso os alunos podem encontrar esse professor buscando a matéria, dia e hora que batem com a do professor cadastrado.

Desktop

Mobile

🏁 Iniciando

Instruções de como acessar as rotas e instalação.

⚒ Instalando

# É necessário ter o docker na sua máquina

git clone https://github.com/Gabrielpdev/Proffy.git

# Go into the backend repository

$ cd Proffy
$ cd backend
yarn

# Configure seu .env baseado no .env.example
# Configure seu .ormconfig.json baseado no .ormconfig.example.json
$ yarn typeorm migration:run
$ yarn start
# server inicializado

# 💻 Iniciando com o Front-end
$ cd web
$ yarn
$ yarn start

# 📱 Iniciando com o Mobile

$ cd mobile
$ yarn
$ yarn start

⛏️ Tecnologias Utilizadas

As seguintes ferramentas foram usadas na construção do projeto:

• 🔵 TypeScript
• 🟢 Node Js
• 🔴 Redis
• ⚙ TypeORM
• 🐘 Postgres
• 👄 Handlebars
• 📷 Expo Image Picker
• ⚛️ React
• ⚛️ React Native
• 🔼 Expo
• 💅 Styled-components

👨‍💼 Metas de desenvolvimento

• Desenvolver o sistema de cadastro/login de usuário.
• Desenvolver o sistema de cadastro de professores.
• Desenvolver o sistema de filtro de professores por dia-materia-hora.
• Desenvolver o sistema de conexão entre alunos e professores.
• Desenvolver o sistema de alteração de dados do usuario.

🤔 Como contribuir

• Faça um fork desse repositório;
• Cria uma branch com a sua feature: git checkout -b minha-feature;
• Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
• Faça push para a sua branch: git push origin minha-feature.

Feito com ❤️ por Gabriel Pereira 👋🏽 Entre em contato!