Skip to content

Latest commit

 

History

History
120 lines (94 loc) · 2.67 KB

README.md

File metadata and controls

120 lines (94 loc) · 2.67 KB
Raw

candidate-apointment-api

Description

This is a a TypeScript powered REST API backend service to create candidates and book their appointments on availability.

  • platform: AWS
  • language: TypeScript
  • runtime/environment: NodeJS
  • dbSolution: dynamoDB
  • framewrok: serverless
  • authorName: Md Rijwan Razzaq Matin
  • authorLink: 'https://github.com/mdrijwan'

Getting Started

Clone the project repository by running the command below.

SSH:

git clone git@github.com:mdrijwan/candidate-apointment-api.git

HTTPS:

git clone https://github.com/mdrijwan/candidate-apointment-api.git

GitHub CLI:

gh repo clone mdrijwan/candidate-apointment-api

Run the command below to install NPM dependencies

npm install

To install dynamodb for local development

sls dynamodb install

Then start the server and follow the instructions in the console.

npm run start

To deploy the data resources on AWS

npm run predeploy

To deploy the stack on AWS

npm run deploy
  • This project is powered by TypeScript so no compilation needed.
  • You need to install dynamodb-local for local development but no worries, preinstall script will do that for you automatically.
  • You need to deploy data resources before deploying the stackbut no worries, predeploy script will do that for you automatically.

Let's get started!

Methods

  • GET/

    • GET/candidate (List all the Candidates)
    • GET/candidate/{id} (List all the Appointments for a given Candidate)
    • GET/appointment/{id}?{date} (List all the Appointments for a given Candidate on a given date)
    • GET/availability} (List all the Available Appointments for a all Candidates)
    • GET/availability/?{date} (List all the Available Appointments for a all Candidates on a given date)
    • GET/availability/{id} (List all the Available Appointments for a given Candidate)

  • POST/

    • POST/candidate (Create Candidates)

  • PUT/

    • PUT/appointment/{id} (Create Appointments for a given Candidate)

Functions

  • createCandidate
  • createAppointment
  • listCandidates
  • listAppointments
  • listAvailability
  • getAppointment
  • getAvailability

Project Structure

aws-serverless-api
├─ src
│ ├─ api
│ │ ├─ create.ts
│ │ ├─ get.ts
│ │ └─ list.ts
│ ├─ helpers
│ │ ├─ common.ts
│ │ ├─ formatter.ts
│ │ └─ model.ts
│ ├─ resources
│ │ └─ seedData.json
│ ├─ validator
│ │ ├─ candidate.json
│ │ └─ appointment.json
├─ .gitignore
├─ package.json
├─ package-lock.json
├─ serverless.yml
├─ serverless.data.yml
├─ serverless.local.yml
├─ tsconfig.json
└─ tslint.json