Uma plataforma fácil e intuitiva para publicação e compartilhamento de artigos. O Artigo Livre oferece uma interface simples e amigável, permitindo que autores publiquem seus conteúdos com visuais personalizados e os leitores tenham acesso a artigos bem organizados.
O Artigo Livre foi desenvolvido para facilitar a criação e compartilhamento de artigos em uma plataforma aberta e intuitiva. Com funcionalidades para personalização visual, os autores podem inserir capas personalizadas e banners, proporcionando uma experiência imersiva para os leitores.
Principais Funcionalidades:
- Publicação Rápida: Publique artigos de forma fácil, com suporte a customizações.
- Personalização Visual: Adicione capas e imagens personalizadas para dar destaque aos seus conteúdos.
- HTML, CSS, JavaScript: Para estrutura e interatividade da interface.
- Node.js: Utilizado para o ambiente de execução no backend.
- Firebase:
- Authentication: Gerencia a autenticação de usuários de forma segura.
- Firestore Database: Armazena os artigos com eficiência em uma coleção estruturada.
- Firebase Storage: Gerencia o armazenamento de imagens em tempo real.
Antes de iniciar, você precisará ter as seguintes ferramentas instaladas:
- Node.js (v14.0.0 ou superior)
- npm (gerenciador de pacotes)
- Firebase CLI (para configurar o Firebase no projeto)
O projeto utiliza Firebase Authentication, Firestore e Firebase Storage. Abaixo estão as etapas para configurar seu Firebase no projeto.
- Acesse Firebase Console.
- Crie um novo projeto.
- Habilite Authentication e configure o provedor de autenticação desejado (por exemplo, Google, Email/Password).
- No menu lateral, ative o Firestore Database e crie uma coleção chamada
articles. - Ative o Firebase Storage para armazenar imagens, crie um bucket de storage chamado
uploads.
No arquivo firebase-init.js, adicione a configuração gerada pelo Firebase:
const firebaseConfig = {
apiKey: "SUA_API_KEY_AQUI",
authDomain: "SEU_AUTH_DOMAIN",
projectId: "SEU_PROJECT_ID",
storageBucket: "SEU_STORAGE_BUCKET",
messagingSenderId: "SEU_MESSAGING_SENDER_ID",
appId: "SEU_APP_ID"
};Certifique-se de que as regras de segurança do Firestore e do Storage estão configuradas para permitir o acesso necessário (especialmente se você estiver rodando em ambiente de desenvolvimento).
Dentro do Firestore, você deve ter a coleção articles, onde cada documento contém as seguintes propriedades:
- title: O título do artigo (tipo:
string) - content: O conteúdo do artigo (tipo:
string) - bannerUrl: O URL da imagem do banner (tipo:
string) - createdAt: Data de criação (tipo:
timestamp)
O Firebase Storage será utilizado para armazenar as imagens dos banners. Certifique-se de que seu bucket de storage esteja configurado corretamente com permissões adequadas para leitura e gravação.
Siga as etapas abaixo para clonar e configurar o projeto localmente.
- Clone o repositório:
$ git clone https://github.com/luismede/artigo-livre
$ cd artigo-livre- Instale as dependências:
$ npm install- Configure o Firebase:
Preencha o arquivo firebase-init.js com suas credenciais do Firebase, como mostrado anteriormente.
Para rodar o projeto em ambiente local:
- Execute o comando abaixo para iniciar o servidor local na porta
3000:
$ npm start- Abra o navegador e acesse
http://localhost:3000.
Contribuições são sempre bem-vindas! Siga os passos abaixo para contribuir:
- Faça um fork do projeto.
- Crie uma nova branch para sua feature ou correção de bug:
git checkout -b minha-feature. - Faça suas alterações e faça o commit:
git commit -m 'Adicionando nova feature'. - Envie para o repositório remoto:
git push origin minha-feature. - Abra um Pull Request e descreva suas mudanças.
Se você tiver qualquer dúvida, pode me contatar pelo e-mail ou LinkedIn:
- Email: luishenrique23h@hotmail.com
- LinkedIn: Meu LinkedIn
Este projeto está licenciado sob a MIT License - veja o arquivo LICENSE para mais detalhes.