{"id":25588436,"url":"https://github.com/jhordyess/employees-api-node","last_synced_at":"2026-04-11T03:30:20.929Z","repository":{"id":218722698,"uuid":"747182562","full_name":"jhordyess/employees-api-node","owner":"jhordyess","description":"REST API that allows you to manage employees and departments in a company.","archived":false,"fork":false,"pushed_at":"2024-04-29T14:07:03.000Z","size":257,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-29T15:29:53.526Z","etag":null,"topics":["docker-compose","express","express-validator","jwt-token","nodejs","prisma-orm","sql-server","swagger-ui","typescript","webpack"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jhordyess.png","metadata":{"files":{"readme":"README.md","changelog":"history.sh","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":"2024-01-23T12:38:41.000Z","updated_at":"2024-04-29T14:07:07.000Z","dependencies_parsed_at":"2024-02-10T23:26:20.912Z","dependency_job_id":"e135f7bb-a29d-4180-be71-2d5a54f29f9f","html_url":"https://github.com/jhordyess/employees-api-node","commit_stats":null,"previous_names":["jhordyess/empleados-api-node","jhordyess/employees-api-node"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhordyess%2Femployees-api-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhordyess%2Femployees-api-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhordyess%2Femployees-api-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhordyess%2Femployees-api-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jhordyess","download_url":"https://codeload.github.com/jhordyess/employees-api-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239985719,"owners_count":19729512,"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":["docker-compose","express","express-validator","jwt-token","nodejs","prisma-orm","sql-server","swagger-ui","typescript","webpack"],"created_at":"2025-02-21T08:37:30.692Z","updated_at":"2026-04-11T03:30:20.862Z","avatar_url":"https://github.com/jhordyess.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Employees API in Node\n\nREST API that allows you to manage employees and departments in a company.\n\n## Description\n\nREST API allows you to manage employees and departments in a company. You can use it to add, update, and delete employees and departments; also includes authentication and Swagger documentation.\n\n### Technologies Used\n\n- Node modules: [Express](https://expressjs.com/), [Prisma](https://www.prisma.io/), [Swagger UI](https://swagger.io/tools/swagger-ui/)\n- Programming Language: [TypeScript](https://www.typescriptlang.org/)\n- Build Tool: [Webpack](https://webpack.js.org/)\n- Database: [SQL Server](https://www.microsoft.com/en/sql-server/sql-server-downloads)\n- Dev Environment: [VSCode](https://code.visualstudio.com/) with [dev containers](https://code.visualstudio.com/docs/devcontainers/containers) in [Zorin OS](https://zorinos.com/)\n\n### Screenshot\n\n![Swagger UI](https://res.cloudinary.com/jhordyess/image/upload/v1712957082/employees-api-node/swagger.png)\n\n## How to use for development\n\n1. Clone the repository:\n\n```bash\ngit clone git@github.com:jhordyess/employees-api-node.git\n```\n\n2. Open the project folder:\n\n```bash\ncd employees-api-node\n```\n\n3. Create a `.env` file in the root folder by copying the example from the `.env.example` file. And replace the values with your own.\n\n4. Configure SQL Server if needed. You can following the [SQLServerConfig.md](./docs/SQLServerConfig.md) guide.\n\n5. Install the dependencies:\n\n```bash\nyarn\n```\n\n6. Run the project:\n\n```bash\nyarn dev\n```\n\n7. Now you can test the endpoints at \u003chttp://localhost:3000/api/v1\u003e. The API docs(Swagger UI) will be available at \u003chttp://localhost:3000/api/v1/docs\u003e\n\n## How to use for development with Docker\n\nYou can use the VSCode dev containers to run the project in a containerized environment.\n\nYou need to have installed [Docker](https://www.docker.com/) and [VSCode](https://code.visualstudio.com/), and the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension.\n\n1. Clone the repository:\n\n```bash\ngit clone git@github.com:jhordyess/employees-api-node.git\n```\n\n2. Open the project with VSCode:\n\n```bash\ncode employees-api-node\n```\n\n3. Create a `.env` file in the root folder by copying the example from the `.env.example` file. And replace the values with your own.\n\n4. Open the terminal in VSCode, and run the docker compose file:\n\n```bash\ndocker compose -f docker-compose.dev.yml up -d\n```\n\n5. Open the command palette and select the option `Dev Containers: Reopen in Container`.\n\n6. Wait for the container to be built and the project to be started.\n\n7. Open the terminal in VSCode and run the project:\n\n```bash\nyarn dev\n```\n\n8. Now you can test the endpoints at \u003chttp://localhost:3000/api/v1\u003e. The API docs(Swagger UI) will be available at \u003chttp://localhost:3000/api/v1/docs\u003e\n\n## How to use for production with Docker\n\nTo run the project in production with Docker, remember to create the `.env` file and replace the values with your own.\n\nThen, run the following command in the terminal:\n\n```bash\ndocker compose -f docker-compose.prod.yml up -d\n```\n\nTo stop or remove, run:\n\n```bash\ndocker compose -f docker-compose.prod.yml down\n```\n\nTake note that this production configuration is just for testing purposes, and may not be suitable for a real production environment.\n\n## To-Do\n\n- [x] Fully translate the API documentation to English\n- [ ] Elaborate the Entity-Relationship Diagram\n\n## Contribution\n\nIf you would like to contribute to the project, open an issue or make a pull request on the repository.\n\n## License\n\n© 2024\u003e [Jhordyess](https://github.com/jhordyess). Under the [MIT](https://choosealicense.com/licenses/mit/) license. See the [LICENSE](./LICENSE) file for more details.\n\n---\n\nMade with 💪 by [Jhordyess](https://www.jhordyess.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhordyess%2Femployees-api-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjhordyess%2Femployees-api-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhordyess%2Femployees-api-node/lists"}