{"id":19536929,"url":"https://github.com/alexgalhardo/tech-challenge-serverless","last_synced_at":"2025-02-26T04:22:15.067Z","repository":{"id":217314377,"uuid":"743560831","full_name":"AlexGalhardo/tech-challenge-serverless","owner":"AlexGalhardo","description":"Tech challenge to do a simple API using serverless framework, using these technologies:","archived":false,"fork":false,"pushed_at":"2024-06-09T17:01:05.000Z","size":351,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-24T06:51:56.753Z","etag":null,"topics":["api","aws","aws-sdk","dynamodb","serverless","serverless-framework"],"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/AlexGalhardo.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-15T13:53:49.000Z","updated_at":"2024-06-09T17:01:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"0771bbdf-495b-4189-9275-ce38ec664e7d","html_url":"https://github.com/AlexGalhardo/tech-challenge-serverless","commit_stats":null,"previous_names":["alexgalhardo/tech-challenge-serverless"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGalhardo%2Ftech-challenge-serverless","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGalhardo%2Ftech-challenge-serverless/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGalhardo%2Ftech-challenge-serverless/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGalhardo%2Ftech-challenge-serverless/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlexGalhardo","download_url":"https://codeload.github.com/AlexGalhardo/tech-challenge-serverless/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240790285,"owners_count":19858008,"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":["api","aws","aws-sdk","dynamodb","serverless","serverless-framework"],"created_at":"2024-11-11T02:24:56.196Z","updated_at":"2025-02-26T04:22:15.035Z","avatar_url":"https://github.com/AlexGalhardo.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n  \t\u003ch1 align=\"center\"\u003eTech Challenge Serverless\u003c/h1\u003e\n\u003c/div\u003e\n\n## Introduction\n- Tech challenge to do a simple API using serverless framework, using these technologies:\n- [NodeJS v20](https://nodejs.org)\n- [TypeScript](https://www.typescriptlang.org/)\n- [Serverless Framework](https://www.serverless.com/)\n- [AWS](https://aws.amazon.com/)\n   - [Lambda](https://aws.amazon.com/lambda/)\n   - [DynamoDB](https://aws.amazon.com/dynamodb/)\n   - [API Gateway](https://aws.amazon.com/api-gateway/)\n\n## Prerequisites\n- See documentation: [docs/settings-to-run-this-project](./docs/settings-to-run-this-project.md)\n\n## Local Developent Setup\n\n1. Clone this repository\n```bash\ngit clone git@github.com:AlexGalhardo/tech-challenge-serverless.git\n```\n\n2. Enter repository\n```bash\ncd tech-challenge-serverless/\n```\n\n3. Install dependencies\n```bash\nnpm install\n```\n\n4. Don't forget to setup your AWS credentials locally (prerequisites) to be able to access DynamoDB in AWS\n- Example in MacOS terminal:\n```bash\nexport AWS_ACCESS_KEY_ID=YOU_AWS_ACCESS_KEY_ID\nexport AWS_SECRET_ACCESS_KEY=YOUR_AWS_ACCESS_KEY_ID\n```\n\n5. Up server locally\n```bash\nnpm run dev\n```\n\n## Deploying to AWS\n\na. Login to your Serverless Account\n```bash\nsls login\n```\n\nb. In `https://app.serverless.com/your_user_name/settings/providers`\n   - a. Click button at end right: `+ Create Provider`\n   - b. Give a **name to your org provider**, like: `alexgalhardo` for example\n   - c. Click button: `Connect AWS Provider`\n   - You are gonna be redirect to your AWS Console\n   - Confirm clicking button: `Create Stack`\n   - When is finished, your page: `https://app.serverless.com/your_user_name/settings/providers` will be updated\n\nc. In `https://app.serverless.com/your_user_name/apps`\n   - a. Click on \"Create App\"\n   - b. Give your **app name**, like: `serverless-dynamodb-api` for example\n   - c. Created your app, click on \"crete service\" and give your **service name**, like: `serverless-dynamodb-api` for example\n   - d. Paste the org, app and service name into serverless.yml\n\nd. Run command\n```bash\nsls deploy\n```\n\n## Remove Deploy from AWS\n```bash\nsls remove\n```\n\n## API Requests\n- You can use the HTTP Requests inside [rest-client/](./rest-client/) folder using the VSCode extension [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client)\n\n## Docs\n- You can see and add important documentation about this code repository in the [docs/](./docs/) folder\n\n## License\n\n[MIT](http://opensource.org/licenses/MIT)\n\nCopyright (c) March 2024-present, [Alex Galhardo](https://github.com/AlexGalhardo)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexgalhardo%2Ftech-challenge-serverless","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexgalhardo%2Ftech-challenge-serverless","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexgalhardo%2Ftech-challenge-serverless/lists"}