Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mamori-i-japan/mamori-i-japan-api
REST API Server for Japanese Exposure Notification App to fight against COVID-19 a.k.a. "まもりあいJAPAN".
https://github.com/mamori-i-japan/mamori-i-japan-api
Last synced: about 1 month ago
JSON representation
REST API Server for Japanese Exposure Notification App to fight against COVID-19 a.k.a. "まもりあいJAPAN".
- Host: GitHub
- URL: https://github.com/mamori-i-japan/mamori-i-japan-api
- Owner: mamori-i-japan
- License: bsd-2-clause
- Created: 2020-04-12T06:48:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T02:30:43.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T13:35:51.384Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 8.19 MB
- Stars: 176
- Watchers: 18
- Forks: 13
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-nestjs - Serverless-Lambda-FirestoreDB - A fully SERVERLESS in-production application with AWS Lambda, FirestoreDB, Firebase Auth, Winston Logger, Swagger. Also implements admin role authorization. (Resources)
README
# mamori-i-japan-api
[](https://circleci.com/gh/mamori-i-japan/mamori-i-japan-api)
[](https://github.com/mamori-i-japan/mamori-i-japan-api/releases)
[](./LICENSE)
REST API Server for Japanese Exposure Notification App to fight against COVID-19 a.k.a. \"まもりあい Japan\".
## Table of Contents
1. [Architecture](#Architecture)
1. [Technology Stack](#Technology-Stack)
1. [Getting Started](#Getting-Started)
1. [Development Guideline](#Development-Guideline)
1. [Demo](#Demo)
1. [Test Reports](#Test-Reports)
1. [Contact](#Contact)
1. [Contributing](#Contributing)
1. [Code of Conduct](#Code-of-Conduct)
1. [License](#License)
## Architecture
### Overview and Data Flow Diagram
The images made by [Miro](https://miro.com/app/board/o9J_ksGHtPE=/) (read only access).
## Technology Stack
### Application
- Runtime Environment: [Node.js 12.16.2](https://nodejs.org/)
- Package Manager: [npm 6.14.4](https://www.npmjs.com/)
- Programming Language Processor: [TypeScript 3.8.3](https://www.typescriptlang.org/)
- Web Application Framework: [Nest 7.0.7](https://nestjs.com/)
### Hosting
#### Amazon Web Services
- Amazon Route 53
- Amazon API Gateway
- AWS Lambda
- AWS Systems Manager
- [Serverless Framework](https://serverless.com/) (to manage and deploy)
#### Firebase
- Firebase Authentication
- Cloud Firestore
- Cloud Storage
## Getting Started
### Installation
```sh
npm install
```
### Running the Application on Local
Make sure you add the env vars in `.env` file. Just copy the `.env.template` file.
```
# Used by serverless framework to deploy to AWS Lambda.
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
# Used by Firebase Admin SDK. Obtained via serviceAccount.json file in Firebase Console.
FIREBASE_type
FIREBASE_project_id
FIREBASE_private_key_id
FIREBASE_private_key
FIREBASE_client_email
FIREBASE_client_id
FIREBASE_auth_uri
FIREBASE_token_uri
FIREBASE_auth_provider_x509_cert_url
FIREBASE_client_x509_cert_url
# Used for getting Firebase Token via Custom token in e2e tests. Obtained in Firebase Console.
FIREBASE_WEB_API_KEY
```
And then execute:
```sh
# development mode
npm run start
# watch mode
npm run start:dev
# serverless offline mode
npm run sls-offline
# production mode
npm run start:prod
```
### Testing
```sh
# unit tests
npm run test
# end-to-end tests
npm run test:e2e
# get the test coverage
npm run test:cov
```
### Deployment
```sh
# deploy to DEV environment
npm run deploy:dev
```
## Development Guideline
### Project Layout (Brief Explanation)
```
.
├── .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.controller.ts (Controllers call their services)
│ │ ├── users.service.ts (Services can call other services and their own repository)
│ │ └── user.repository.ts (Repository should be called only by its parent service)
│ └── shared (module with shared business logic)
├── test (Contains the end-to-end (e2e) tests)
├── fdt-generator-webapp (Optional web app to generate firebase access tokens for testing)
└── serverless.yml (Serverless framework config file for infrastructure deployment)
```
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.
1. **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.
1. **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`.
## Demo
- Swagger UI: https://api-demo.mamori-i.jp/swagger
## Test Reports
- [Load Testing](https://docs.google.com/spreadsheets/d/1qiYa7g6ridHUalt3PVmS8lluR9VV3Y5EkMeMFpvx2AI/edit?usp=sharing)
- [Internal Penetration Testing](https://docs.google.com/document/d/1OfCHe0gPAP1MTm5kr68lDkvBgg1JImvt7TguHLq5NUs/edit?usp=sharing)
## Contact
- [Contact Form](https://docs.google.com/forms/d/e/1FAIpQLSfcGM9itQ3i--GN9FUsQpdlW58Ug4Y6lcnE11N-igILDJdZlw/viewform)
## Contributing
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](http://contributor-covenant.org) code of conduct.
## Contributors
- [Yash Murty](https://github.com/yashmurty)
- [Shogo Mitomo](https://github.com/shogo-mitomo)
- [Daisuke Hirata](https://github.com/DaisukeHirata)
## Code of Conduct
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](./CODE_OF_CONDUCT.md).
## License
The app is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).
## External links/posts
Links to some external articles and blog posts that talk about the backend in more detail.
In Japanese language (日本語で):
- Mamoriai Japan Official - [まもりあい JAPAN 公式](https://note.com/mamoriai)
- Takuya Kawatsu - [Overall design of the application](https://note.com/_takukawa_/n/n12b816168ca2)
- Daisuke Hirata - [Development story](https://note.com/daisukehirata/n/n896f633b08ad)
In English:
- Yash Murty - [Backend for Japan's Contact Tracing App](https://yashmurty.com/blog/japans-contact-tracing-app/)