ckauan / happy-web Goto Github PK

Levando felicidade para o mundo

⚠️ Atenção: Essa é apenas o front-end do projeto, você pode encontrar as outras partes aqui.
📱 Mobile 💻 Web 🌐 Back-end

• Sobre o projeto
• Iniciando
• Telas
• Contribuições
• Licença
• Contato

💡 Projeto idealizado para a divulgação de orfanatos locais por meio de cadastro.

📌 Essas foram as tecnologias mais utilizados no decorrer do projeto

• Typescript
• React

🔖 Para rodar o projeto localmente você precisará seguir algumas intruções

• É necessário que o NodeJS esteja instalado em sua máquina
• Você também irá precisar de um gerenciador de pacotes, nesse projeto usei o Yarn

# Clone o repositório
git clone https://github.com/cKauan/happy-web.git

# Instale todos os pacotes

# Yarn
yarn install
# Npm
npm install

# Crie um arquivo .env e insira essas variáveis

REACT_APP_API_URL= Endereço da Api ( Servidor )
REACT_APP_GOOGLE_CLIENT_ID= Id de usuário google, para login
REACT_APP_MAPBOX_TOKEN= Token de autorização MapBox

# Acesse o arquivo src/services/Api.ts e insira suas informações sobre a conexão.

# Ambiente de desenvolvimento

# Yarn
yarn dev
# Npm
npm run dev

# Ambiente de Produção

# Yarn
yarn build
# Npm
npm run build

🎯 Você quer contribuir para o projeto e não sabe como?

1. Dê Fork no projeto
2. Crie uma branch para sua feature (git checkout -b feature/AmazingFeature)
3. Comite as alterações (git commit -m 'Add some AmazingFeature')
4. Faça o push para a branch (git push origin feature/AmazingFeature)
5. Abra um Pull Request

MIT

👦 Carlos Kauãn - https://twitter.com/carlaodamassaa - [email protected]

⚡ Link do projeto: https://github.com/cKauan/happy-web

Feito com 💚 por Carlos Kauãn