{"id":25249803,"url":"https://github.com/mateuseap/oncase-challenge","last_synced_at":"2026-05-06T20:31:35.080Z","repository":{"id":128956903,"uuid":"584923279","full_name":"mateuseap/Oncase-Challenge","owner":"mateuseap","description":"Oncase | Fullstack Challenge","archived":false,"fork":false,"pushed_at":"2024-05-26T09:16:22.000Z","size":1641,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T03:51:30.406Z","etag":null,"topics":["axios","nestjs","react","swagger","typeorm","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/mateuseap.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":"2023-01-03T21:36:57.000Z","updated_at":"2023-08-13T22:46:21.000Z","dependencies_parsed_at":"2023-06-14T22:45:24.183Z","dependency_job_id":null,"html_url":"https://github.com/mateuseap/Oncase-Challenge","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/mateuseap%2FOncase-Challenge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mateuseap%2FOncase-Challenge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mateuseap%2FOncase-Challenge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mateuseap%2FOncase-Challenge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mateuseap","download_url":"https://codeload.github.com/mateuseap/Oncase-Challenge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247406112,"owners_count":20933806,"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":["axios","nestjs","react","swagger","typeorm","typescript"],"created_at":"2025-02-12T03:50:57.319Z","updated_at":"2026-05-06T20:31:35.038Z","avatar_url":"https://github.com/mateuseap.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Oncase Fullstack Challenge\n\n## 🔧 Pre-requisites\n\nBefore running the project, you must have the following tools installed on your machine: \n* [Git](https://git-scm.com/book/pt-br/v2/Come%C3%A7ando-Instalando-o-Git)\n* [Node.js](https://nodejs.org/pt-br/download/package-manager/) \n* [Docker](https://www.docker.com/)\n* NPM or Yarn\n\nAlso, you will need to clone the repository:\n\n```bash\n## Cloning the repository\ngit clone https://github.com/mateuseap/Oncase-Challenge\n\n## Entering the directory\ncd Oncase-Challenge\n```\n\n## 🚀 Back-end\n\n```bash\n## Entering the directory\ncd back-end\n```\n\n### \u003e Setting the environment variables\n\nCreate a file named ``.env`` and copy and past in it what is inside the ``.env.example`` file (create the ``.env`` file in the same place that ``.env.example`` file is localized).\n\n### \u003e Docker image setup\n\nTo create and run a ``Postgres`` docker image and also start a database, open up a terminal and run the following command: \n\n```docker\n# Run the docker image of postgres\ndocker run --name dashboard -e POSTGRES_PASSWORD=docker -e POSTGRES_DB=dashboard -e POSTGRES_USER=postgres -p 5432:5432 -d postgres\n```\n\n\u003e If you already have a ``Postgres`` image or driver on your PC, simply create a new database:\n~~~~sql\n  CREATE DATABASE \"dashboard\";\n~~~~\n\n### \u003e Running the migrations\n\nYou have to build the application before running the migrations:\n\n```bash\n# Installing the dependencies\nnpm install\n\n# Building the application\nnpm run build\n```\n\nTo run the migrations:\n```bash\n# Running the migration\nnpm run typeorm:run-migrations\n```\n\n### \u003e Running the app\n\n\n```bash\n# Development\nnpm run start\n\n# Watch mode\nnpm run start:dev\n\n# Production mode\nnpm run start:prod\n```\n\nOpen [http://localhost:3000/dashboard/api/swagger](http://localhost:3000/dashboard/api/swagger) to vsualize the ``Swagger`` of this project in your browser. There you can test all the endpoints of the API without needing softwares like ``Postman`` and ``Insomnia``\n\n![swagger](https://i.imgur.com/rZR7qmt.png)\n\n### \u003e Resetting the database\n\nTo reset the database, you'll need to run the following command:\n\n```bash\n# Resetting the database\nnpm run typeorm:schema-drop\n```\n\nAfter running it, you'll just need to run the back-end app again and the database will be already reseted.\n\n### \u003e Running tests\n\n```bash\n# Controllers unit tests\nnpm run test:controllers\n```\n\nYou should receive an output like this:\n\n![controllers-unit-tests](https://i.imgur.com/xf9jWoP.png)\n\n## 🚀 Front-end\n\n```bash\n## Entering the directory\ncd front-end\n```\n\n### \u003e Setting the environment variables\n\nCreate a file named ``.env`` and copy and past in it what is inside the ``.env.example`` file (create the ``.env`` file in the same place that ``.env.example`` file is localized).\n\n### \u003e Running the app\n\n```bash\n## Installing the npm dependencies\nnpm install\n\n## Starting the project (development environment)\nnpm start\n```\n\nOpen [http://localhost:3001/dashboard](http://localhost:3001/dashboard) to view it in the browser.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmateuseap%2Foncase-challenge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmateuseap%2Foncase-challenge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmateuseap%2Foncase-challenge/lists"}