{"id":22404903,"url":"https://github.com/neorandom/quickmart-website","last_synced_at":"2026-02-07T23:33:55.055Z","repository":{"id":264712441,"uuid":"880279887","full_name":"neoRandom/quickmart-website","owner":"neoRandom","description":"QuickMart é um projeto multiplataforma para um minimercado fictício. Esse website é a parte principal do projeto da Feira Tecnológica da Etec da Zona Leste de 2024.","archived":false,"fork":false,"pushed_at":"2024-12-03T04:19:34.000Z","size":2602,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-03T05:24:34.619Z","etag":null,"topics":["bash","css","javascript","mysql","node","php","shell","tailwindcss","typescript","web","website"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neoRandom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-29T12:52:57.000Z","updated_at":"2024-12-03T04:19:38.000Z","dependencies_parsed_at":"2024-11-25T23:34:25.627Z","dependency_job_id":null,"html_url":"https://github.com/neoRandom/quickmart-website","commit_stats":null,"previous_names":["neorandom/quickmart-website"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoRandom%2Fquickmart-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoRandom%2Fquickmart-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoRandom%2Fquickmart-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoRandom%2Fquickmart-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neoRandom","download_url":"https://codeload.github.com/neoRandom/quickmart-website/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228274995,"owners_count":17895008,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","css","javascript","mysql","node","php","shell","tailwindcss","typescript","web","website"],"created_at":"2024-12-05T10:15:54.234Z","updated_at":"2026-02-07T23:33:55.002Z","avatar_url":"https://github.com/neoRandom.png","language":"PHP","readme":"# QuickMart Website - Projeto Multiplataforma\n\n\u003e \"Não importa a aparência do carro, sem um bom motor ele só serve para impressionar quem vê sua garagem\"\n\nO **QuickMart** Website é um dos dois sistemas para o projeto interdisciplinar da Feira Tecnológica da Etec da Zona Leste (2024), que tem como objetivo criar um sistema multiplataforma para uma empresa fictícia.\n\nMeu objetivo principal foi desenvolver um sistema de forma profissional, visando utilizar as técnicas e tecnologias necessárias para tal, além de um código limpo, escalável e legível. Tenho como meta um sistema seguro, escalável, profissional e de fácil manutenção.\n\nLink para o outro sistema do projeto interdisciplinar: [Projeto Minimercado](https://github.com/neoRandom/projeto-minimercado)\n\n## Sumário\n\n- [Guia de instalação](#guia-de-instala%C3%A7%C3%A3o)\n- [Tecnologias Utilizadas](#tecnologias-utilizadas)\n- [Documentação](#documenta%C3%A7%C3%A3o)\n- [Diferenciais](#diferenciais)\n- [To-do list](#lista-de-funcionalidades-to-do-list)\n- [Desenvolvedores](#desenvolvedores)\n- [Licença](#licen%C3%A7a)\n\n## Guia de instalação\n\nEste guia de instalação é para usuários de Windows.\n\n\u003e Nota 1: O projeto foi feito majoritariamente em Linux, para ver o guia de instalação para Linux, clique [aqui](docs/installation_guide.md#linux).\n\nPré-requisitos:\n- XAMPP/WAMPP instalado.\n- NodeJS e NPM instalados.\n- Conhecimento básico com Shell/CLI (CMD do Windows).\n- Conhecimento básico com phpMyAdmin.\n- Ter a pasta do projeto em sua máquina, seja baixando o `.zip` ou usando o comando `git clone https://github.com/neoRandom/quickmart-website.git`. Veja a `Nota 2` dessa seção.\n\nPasso a Passo:\n- Iniciar o Apache e o MySQL por meio do Painel de Controle do XAMPP.\n- Carregar o Banco de Dados no phpMyAdmin.\n  - Primeiro o *Schema* (estrutura) do arquivo (`./database/schema.sql`).\n  - Em seguida, os registros (dados) do arquivo (`./database/data.sql`). (**opcional**)\n- Configurar um arquivo `.env` (variáveis de ambiente) na pasta `config/`, se baseando no arquivo de exemplo `.env.example`.\n- Instalar os módulos do Node usando o comando `npm install`.\n- Executar o comando principal de execução (Windows) `npm run dev:w`.\n- Abrir em um navegador a URL `http://localhost/quickmart/public/admin` [link](http://localhost/quickmart/public/admin).\n\n\u003e Nota 2: Não é necessário baixar o projeto na pasta `htdocs`, pois o comando principal de execução já adiciona todos os arquivos necessários para o website na pasta `htdocs/quickmart`.\n\n## Tecnologias Utilizadas\n\n\u003cimg src=\"https://skillicons.dev/icons?i=html,css,js,ts,tailwind,php,mysql,npm,figma,bash,postman\" /\u003e\n\n\u003e - Figma: Design das páginas.\n\u003e - Bash: Scripts para automação.\n\u003e - Postman: Teste dos endpoints e requisições.\n\u003e - XAMPP (não incluído na lista visual): *Server Tech Stack* utilizado no desenvolvimento.\n\n## Documentação\n\nOs diagramas relacionados ao Banco de Dados podem ser encontrados [aqui](/). (Link incompleto)\n\nGrande parte do funcionamento do sistema já é descrito no próprio código (com *Self-Documenting Code*, *Docstrings*, entre outros), mas uma visão completa pode ser encontrada na pasta [docs](docs/index.md), clique para saber mais.\n\nEntre os elementos da documentação, estão incluidos:\n- Descrição do projeto (features e diferenciais)\n- Guia de instalação\n- Estrutura de pastas (baseado em Laravel)\n- Arquitetura geral\n- Utilização das tecnologias\n- *To-do list* completa\n- Fluxo do código\n- Lista de *endpoints*\n- Protocolos de segurança\n- Referências de estudo\n\n## Diferenciais\n\n\u003e Para ver a lista completa, clique [aqui](docs/unique_features.md).\n\n\u003e Nota: Essa lista é principalmente em relação a outros trabalhos da mesma Feira Tecnológica, não refletindo práticas comuns no mercado (autenticação com hash e salt, por exemplo).\n\n- Scripts (tanto para Windows quanto Linux) para desenvolvimento mais dinâmico.\n- Renderizador de HTML baseado em TypeScript (mini-micro-framework pessoal).\n- Sistema de requisições baseado em *endpoints*.\n- Uso de *environment variables* (.env) para segurança de dados do servidor.\n- Uso de *hash* (SHA256) e *salt* (random unsigned 32-bits number) para as credenciais.\n- Uso de *JSON Web Tokens* (JWT) para manter a sessão do usuário.\n- Para fins de aprendizado, o código de todos os componentes foram manualmente feitos do zero.\n\n## Lista de funcionalidades (To-do list)\n\n\u003e Para ver a lista completa, clique [aqui](docs/todo_list.md).\n\n- [x] Banco de Dados\n    - [x] Criação da estrutura (schema)\n    - [x] Criação dos dados (data)\n\n- [x] Back-end\n    - [x] Autoloader\n    - [x] Controllers\n    - [x] Database (classe de Conexão)\n    - [x] Model (classes de modelagem)\n    - [x] Utilities (classes para lidar com)\n\n- [ ] Front-end\n    - [ ] Assets\n    - [x] TypeScript\n    - [x] TailwindCSS/CSS\n    - [x] Dashboard\n    - [x] Login\n\n- [x] Public\n    - [x] Definir os endpoints\n    - [x] Configurar os endpoints\n\n- [x] Testes\n\n## Licença\n\nEsse repositório atualmente não possui licenças externas.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneorandom%2Fquickmart-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneorandom%2Fquickmart-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneorandom%2Fquickmart-website/lists"}