REST API Server for Japanese Exposure Notification App to fight against COVID-19 a.k.a. "まもりあいJapan".

The images made by Miro (read only access).

• Runtime Environment: Node.js 12.16.2
• Package Manager: npm 6.14.4
• Programming Language Processor: TypeScript 3.8.3
• Web Application Framework: Nest 7.0.7

• Amazon Route 53
• Amazon API Gateway
• AWS Lambda
• AWS Systems Manager
• Serverless Framework (to manage and deploy)

• Firebase Authentication
• Cloud Firestore
• Cloud Storage

npm install

Make sure you add the env vars in .env file. Just copy the .env.template file.

And then execute:

# development mode
npm run start

# watch mode
npm run start:dev

# serverless offline mode
npm run sls-offline

# production mode
npm run start:prod

# unit tests
npm run test

# end-to-end tests
npm run test:e2e

# get the test coverage
npm run test:cov

# deploy to DEV environment
npm run deploy:dev

.
├── .env (Make sure to create this file locally and fill the env vars)
├── src
│   ├── main.ts (This entry point is used for local server)
│   ├── lambda-main.ts (This entry point is used for lambda server)
│   ├── auth (module)
│   │   ├── guards
│   │   └── strategies (Implementation of Firebase Auth access token check)
│   └── users (module)
│       ├── users.service.ts (Services can call other services and their own repository)
│       └── user.repository.ts (Repositroy should be called only by its parent service)

As mentioned briefly in the project layout for users, to keep layout clean, we follow this convention:

1. Controllers: HTTP routes map to handler functions in controllers.
2. Services: Controllers call their service function.
   A) A user controller must call only a user service, and not any other service if it can be avoided.
   B) A user service can call other services like cats service, etc.
   C) A user service must call only a user repository, and not any other repository if it can be avoided. If a user service wants to modify data in cats repository, it must call corresponding cats service funtion to do it.
3. Repositories: Repositories have data layer implementation, ex: Firestore in this project. They must be called only by their direct parent service, ex: A user repository is called by a user service.

• Swagger UI: https://api-demo.mamori-i.jp/swagger

• Load Testing
• Internal Penetration Testing

• Contact Form

Bug reports and pull requests are welcome on GitHub at https://github.com/mamori-i-japan/mamori-i-japan-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

• Yash Murty
• Shogo Mitomo
• Daisuke Hirata

Everyone interacting in the mamori-i-japan-api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

The app is available as open source under the terms of the 2-Clause BSD License.