{"id":15659045,"url":"https://github.com/glaucia86/sw-api-node-v1","last_synced_at":"2025-05-05T17:12:52.459Z","repository":{"id":81360479,"uuid":"120363486","full_name":"glaucia86/sw-api-node-v1","owner":"glaucia86","description":"Projeto com o objetivo final de criar uma api que realize as 4 operações do HTTP: GET, DELETE, PUT \u0026 POST. Utilizando das boas práticas de programação e realizando o TDD.","archived":false,"fork":false,"pushed_at":"2018-02-10T21:27:26.000Z","size":191,"stargazers_count":22,"open_issues_count":0,"forks_count":7,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-30T22:32:29.630Z","etag":null,"topics":["bdd","javascript","nodejs","tdd"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/glaucia86.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2018-02-05T21:21:45.000Z","updated_at":"2021-02-12T21:16:14.000Z","dependencies_parsed_at":"2023-07-11T10:35:42.305Z","dependency_job_id":null,"html_url":"https://github.com/glaucia86/sw-api-node-v1","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glaucia86%2Fsw-api-node-v1","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glaucia86%2Fsw-api-node-v1/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glaucia86%2Fsw-api-node-v1/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glaucia86%2Fsw-api-node-v1/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/glaucia86","download_url":"https://codeload.github.com/glaucia86/sw-api-node-v1/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252542067,"owners_count":21764907,"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":["bdd","javascript","nodejs","tdd"],"created_at":"2024-10-03T13:14:45.487Z","updated_at":"2025-05-05T17:12:52.453Z","avatar_url":"https://github.com/glaucia86.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Star Wars API Node.JS by Glaucia Lemos\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://i.imgur.com/YUNJs1N.gif\"/\u003e  \n\u003c/p\u003e\n\nProjeto com o objetivo final de criar uma api que realize as 4 operações do HTTP: GET, DELETE, PUT \u0026amp; POST. Utilizando das boas práticas de programação e realizando o TDD.\n\n## Recursos Utilizados no Desenvolvimento:\n\n- Node.Js;\n- Express.Js\n- MongoDb \u0026 MLab;\n- ES6;\n- Babel (Transpiler);\n- Code Metrics; (análise de desenvolvimento do codigo)\n- Visual Studio Code;\n- Json data (para retornar os dados);\n- PostMan (testar a API criada);\n- TDD (Testes de Unidade e Integração);\n- Mocha, Chai, Sinon \u0026 Supertest; \n- BDD (Behaviour Driven Development);\n\n## Testando a Aplicação no Postman:\nCaso queira testar as API's criadas no projeto, primeiro baixe o [Postman](https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop).\nDepois de realizar o download do Postman, basta agora realizar os passos abaixo para \npoder testar cada API criada!\n\n## Executar Localmente\n\nCaso você deseja executar o projeto na sua máquina local, basta seguir os passos abaixo:\n\n## Começando...\n\nPara começar, você deve simplesmente clonar o repositório do projeto na sua máquina e instalar as dependências.\n\n### Pre-Requisitos\n\nAntes de instalar as dependências no projeto, você precisa já ter instalado na sua máquina:\n\n* **Node.Js**: Caso não tenha, basta realizar o download [Aqui](https://nodejs.org/en/)\n* **MongoDb**: Caso também não tenha, basta realizar o download [Aqui](https://www.mongodb.com/download-center#community)\n\n\n**p.s.: por padrão já estou deixando a conexão de dados do Cloud: MLab, para facilitar todos vocês. Mas, caso queiram testar via MongoDb, bastam baixar e descomentar a connection criada nos arquivos contidos na pasta: 'config'.**\n\n### Instalando as Dependências (via Windows):\n\nAbre o cmd (caso esteja utilizando o Windows) e digite a path do seu projeto\n\n```\ncd \"C:\\Users\\NomeDoComputador\\Documents\\...\"\n```\n\nDepois, quando estiver na pasta do projeto, basta digitar no cmd a seguinte instrução: **(dentro do src)**\n\n```\nnpm install\n```\n\nAo digitar a instrução acima, automaticamente ele irá baixar todas as dependências listadas e definidas no arquivo package.json:\n\n* `node_modules` - que contêm os packages do npm que precisará para o projeto.\n\n## Instalação dos Programas via Linux:\n\nEstarei disponibilizando os links onde explicam como baixar:\n\n- Node.Js: [AQUI](https://nodejs.org/en/download/package-manager/)\n- MongoDb: [AQUI](https://docs.mongodb.com/v3.0/administration/install-on-linux/)\n\n## Padrão das Rotas Criadas: \n\nProcurando seguir o padrão e design das API's, segue abaixo as URI's das rotas a serem desenvolvidas:\n\nobs.: api de exemplo através do site: https://jsonplaceholder.typicode.com\n\n ROTA                      |     HTTP(Verbo)   |      Descrição                |      Links (via PostMan)                 \n-------------------------  | ----------------- | ---------------------         | ---------------------------------------- \n/planets                    |       GET         | Selecionar Todos os Planetas     | GET:    http://localhost:8000/api/planets     \n/planets                     |       POST        | Criar um Post                 | POST:   http://localhost:8000/api/planets\n/planets/:id             |       GET         | Selecionar Por Id             | GET:    http://localhost:8000/planets/:id\n/planets/:nome             |       GET         | Selecionar Por Nome            | GET:    http://localhost:8000/planets/:name\n/planets/:id            |       PUT         | Atualizar Por Id              | PUT:    http://localhost:8000/planets/:id   \n/planets/:id           |       DELETE      | Excluir Por Id                | DELETE: http://localhost:8000/planets/:id\n\n### Executando a Aplicação\n\nPrimeiro, você precisará abrir um terminal na sua máquina e iniciar o MongoDb. Basta digitar na tela do cmd o seguinte comando:\n\n```\nmongod\n```\n\nDepois, abre um outro terminal, para iniciar a aplicação. Para isso, basta iniciar o server para o projeto ser executado localmente. (via nodemon)\n\n```\nnpm start\n```\n\nCaso o MongoDb esteja devidamente instalado em sua máquina, ele iniciará o serviço mostrando que a port 27017 foi iniciada.\n\nAgora, abre a página da aplicação em `http://localhost:8000/api`. E pronto a aplicação será executada de maneira local na sua máquina.  \n\nSe tudo der certo, deverá apresentar a seguinte mensagem:\n\n```\nBem Vindo(a) a API da B2WAds\n```      \n\n## Executando os Testes:\n\nBasta executar o comando: **(dentro da pasta src)**\n\n1) Para Testes de Integração:\n\n```\n\u003e npm run test:integration\n\n```\n\n2) Para Testes de Unidade:\n\n```\n\u003e npm run test:unit\n\n```\n\n**documentação em desenvolvimento**\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglaucia86%2Fsw-api-node-v1","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglaucia86%2Fsw-api-node-v1","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglaucia86%2Fsw-api-node-v1/lists"}