Skip to content

yasu-programming/nest-memo

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Discord Backers on Open Collective Sponsors on Open Collective Donate us Support us Follow us on Twitter

Nest Memo API

NestJS学習用のシンプルなメモアプリケーションのREST API

概要

このプロジェクトは、NestJSの基本的な概念を学習するために作成されたメモ管理APIです。CRUD操作(作成・読取・更新・削除)を通じて、以下のNestJSの機能を学べます:

  • Module、Controller、Serviceの基本構造
  • DTOとバリデーション
  • TypeORMを使用したデータベース操作
  • RESTful APIの設計
  • エラーハンドリング
  • 依存性注入(DI)

API エンドポイント

HTTP Method エンドポイント 説明
POST /memos 新しいメモを作成
GET /memos 全てのメモを取得
GET /memos/:id 特定のメモを取得
PUT /memos/:id メモを更新
DELETE /memos/:id メモを削除

詳細な仕様は docs/api-requirements.md を参照してください。

技術スタック

  • フレームワーク: NestJS
  • データベース: SQLite(開発用)
  • ORM: TypeORM
  • バリデーション: class-validator
  • 変換: class-transformer

Project setup

$ npm install

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g @nestjs/mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

  • Visit the NestJS Documentation to learn more about the framework.
  • For questions and support, please visit our Discord channel.
  • To dive deeper and get more hands-on experience, check out our official video courses.
  • Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
  • Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
  • Need help with your project (part-time to full-time)? Check out our official enterprise support.
  • To stay in the loop and get updates, follow us on X and LinkedIn.
  • Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.

nest-memo

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published