5Pots

Portal de notícias de League of Legends

🚀 Getting Started

O projeto é um monorepo com Yarn Workspaces. O font e back do site 5pots.com está na pasta /app, e em /packages os pacotes npm que originaram dentro do projeto e foram modularizados.

Instale o Yarn junto com o Node. Para usar o banco de dados local, apenas instale o MongoDB no seu PC.

Clone o projeto

git clone https://github.com/RafaelGiro/5pots

Entre na pasta

cd 5pots

Instale as dependências

yarn

Para rodar o site (front/back) utilize o comando:

yarn start

---

Variáveis de ambiente

Antes de rodar a primeira vez o projeto, ainda é necessário adicionar as variáveis de ambiente:

Client

Renomeie o arquivo .env.example para .env na pasta /apps/client e inclua suas chaves. Para o frontend é necessário ter uma chave do Google recaptcha.

NEXT_PUBLIC_RECAPTCHA=
API_URI=http://localhost:5000/
NEXT_PUBLIC_API_URI=http://localhost:5000/

Server

Renomeie o arquivo .env.example para .env na pasta /apps/server e inclua suas chaves. Para o servidor, é necessário ter chave nos seguintes serviços: | Google recaptcha | Google OAuth2 | Facebook OAuth2 | B2 Cloud Storage | Sendgrid

MONGO_URI=mongodb://localhost:27017/5pots-dev
NODE_HOST=localhost
NODE_PORT=5000
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
FACEBOOK_CLIENT_ID=
FACEBOOK_CLIENT_SECRET=
B2_KEY_ID=
B2_APP_KEY=
B2_BUCKET_ID=
SENDGRID_API_KEY=
SENDGRID_EMAIL=

Chaves RSA

Para a autenticação é necessário gerar as chaves RSA. Existe um script dentro de /apps/server/lib/config/keys, para gerar as chaves, vamos apenas rodar os seguintes comandos:

cd apps/server
yarn generate-keys

---

⚙️ Feito com

• Front-end

  • React

  • Nextjs

  • SCSS Modules

• Back-end

  • Node.js

  • Express

  • MongoDB

✔️ À fazer

Verifique nossos issues!

---

⚡️ Contribuindo

1. Clone o projeto

2. Crie uma branch com nome da sua funcionalidade (git checkout -b feature/fooBar)

3. Commit suas mudanças (git commit -am 'Add some fooBar')

4. Push a branch (git push origin feature/fooBar)

5. Crie um Pull Request