diff --git a/README.md b/README.md index 70de6ae..e1a5f23 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,127 @@ +
+ +
+
+ + + + + + +
+ # salvando-labs -This template should help get you started developing with Vue 3 in Vite. +Salvando Labs é uma plataforma desenvolvida para gerenciar os produtos da comunidade open-source SouJunior Labs. Este projeto tem como objetivo centralizar e facilitar o gerenciamento dos produtos criados pela comunidade, proporcionando um ambiente colaborativo e eficiente. -## Recommended IDE Setup +![Logo](./logo-soujunior-labs.png) -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin). +### Obs. Para colaboradores da organização -## Customize configuration +> Antes dos passos de instalação do projeto lembre-se sempre de forkar o repositório oficial e só realizar alterações no repositório "forkado" enviando modificações através de Pull Requests. +> Nunca modifique diretamente o repositório oficial(upstream). -See [Vite Configuration Reference](https://vitejs.dev/config/). +## Menu -## Project Setup +### [Instalação](#instalação) -```sh -npm install +### [Variáveis de Ambiente](#variáveis-de-ambiente) + +### [O que é o SouJunior Labs?](#o-que-é-o-soujunior-labs) + +### [Como surgiu o Salvando-Labs?](#como-surgiu-o-salvando-labs) + +### [Onde estamos e para onde vamos?](#onde-estamos-e-para-onde-vamos) + +### [Stacks Utilizadas](#stacks-utilizadas) + +## Instalação + +> **Pré-requisitos**: Node.js e npm instalados. + +1. Clone o repositório: + +```bash +git clone https://github.com/SouJunior-Labs/salvando-labs.git ``` -### Compile and Hot-Reload for Development +2. Entre na pasta do projeto: -```sh -npm run dev +```bash +cd salvando-labs ``` -### Compile and Minify for Production +3. Instale as dependências: -```sh -npm run build +```bash +npm install ``` -### Run Unit Tests with [Vitest](https://vitest.dev/) +4. Inicie o servidor de desenvolvimento: -```sh -npm run test:unit +```bash +npm run dev ``` -### Run End-to-End Tests with [Cypress](https://www.cypress.io/) +5. Acesse o projeto no navegador: -```sh -npm run test:e2e:dev +```bash +http://localhost:5173 ``` -This runs the end-to-end tests against the Vite development server. -It is much faster than the production build. +## Variáveis de Ambiente -But it's still recommended to test the production build with `test:e2e` before deploying (e.g. in CI environments): +Você pode verificar o repositório da API do labs [aqui](https://github.com/SouJunior-Labs/labs-api) e seguir as instruções para rodar a API localmente. -```sh -npm run build -npm run test:e2e -``` +Após configurar a API, você precisará configurar as variáveis de ambiente do projeto para que a aplicação possa se comunicar com a API. -### Lint with [ESLint](https://eslint.org/) +Para isso, crie um arquivo `.env` na raiz do projeto e adicione a variável `VITE_API_URL` com o endereço da API: -```sh -npm run lint +```bash +VITE_API_URL= http://localhost:3000 ``` -# salvando-labs + +## O que é o SouJunior Labs? + +Somos uma iniciativa voluntária comprometida em criar produtos reais. Nosso propósito é oferecer suporte àqueles que buscam experiência prática, atráves da criação colaborativa de produtos inovadores, assim impulsionamos o desenvolvimento profissional dos membros da comunidade. + +Em nossa comunidade, você encontrará todas as áreas de atuação de um projeto real, como desenvolvimento de software, design, marketing, gestão de projetos, entre outros. Além disso, você terá a oportunidade de trabalhar em um ambiente colaborativo e multidisciplinar, onde poderá aprender e ensinar com outros membros da comunidade. + +Mas não é só isso! Se você já tem experiência e deseja contribuir com a comunidade, também temos espaço para você. Aqui como mentor, você poderá compartilhar seu conhecimento e experiência com outros membros, além de se desenvolver em habilidades como liderança, gestão de projetos, comunicação e muito mais. + +## Como surgiu o Salvando-Labs? + +O Salvando Labs se originou da dificuldade dos administradores e founders da comunidade SouJunior Labs em gerenciar os produtos criados dentro da comunidade. A necessidade de um ambiente centralizado e eficiente para gerenciar os produtos criados pela comunidade foi o que motivou a criação do projeto. + +Os administradores e founders da comunidade perceberam que, com o crescimento da comunidade, era necessário um ambiente que facilitasse o gerenciamento dos produtos criados, pois a comunidade estava crescendo e a quantidade de produtos criados estava aumentando. + +Depois de mais de dezenas de produtos sendo desenvolvidos em paralelo, os administradores e founders perceberam que era necessário um ambiente centralizado e eficiente para automatizar algumas tarefas da rotina do administrador e do founder. + +## Onde estamos e para onde vamos? + +Estamos em nossa versão inicial e, portanto, ainda há muito a ser feito. No entanto, não estamos sozinhos! Com muita dedicação e trabalho em equipe, estamos construindo uma plataforma que atenda às necessidades da comunidade e que seja um ambiente colaborativo e eficiente para gerenciar os produtos. + +Acreditamos que, com o tempo, a plataforma se tornará uma ferramenta essencial para a comunidade, facilitando rotinas e processos, além de proporcionar estrutura para receber todos os novos membros e produtos que estão por vir. + +### Stacks Utilizadas + +**Framework JavaScript:** +Vue.js badge
+**Biblioteca de Componentes:** +Vuetify badge
+**Outras tecnologias:** +JavaScript badge +Axios badge +Pinia badge +HTML badge +CSS badge
+**Ferramentas de Desenvolvimento:** +Insomnia badge +Git badge +GitHub badge + +## Links Úteis + +- [API do Projeto](https://github.com/SouJunior-Labs/labs-api) +- [Comunidade SouJunior Labs](https://soujunior.bcns.ai/labs) +- [Plataforma SouJunior Labs](https://labs.soujunior.tech) \ No newline at end of file diff --git a/logo-soujunior-labs.png b/logo-soujunior-labs.png new file mode 100644 index 0000000..97e4b8e Binary files /dev/null and b/logo-soujunior-labs.png differ