Giter Club home page Giter Club logo

crisis-news-map-next's Introduction

crisis.yuiseki.net

概要

  • Next.js で実装されたアプリケーションです
  • サーバーサイド、クライアントサイド、バッチジョブスクリプトから構成されています
  • Typescript化されています
  • CSS の記述にTailwind CSSを使っています
  • 地図表示のためにreact-leafletを使っています
  • DB として MongoDB を使うためにMongooseを使っています
  • テストライブラリとしてJestを使っています

開発時の注意

  • husky という、コミット・プッシュ前に自動的に ESLint と tsc を実行する Git Hook が使われています
  • ESLint と tsc でエラーになるコードが含まれている場合にはコミットができないので注意してください

開発環境

  • Node.js v16.3.0
  • MongoDB v4.4.6

基本的な開発方法

  • MongoDB サーバーを用意する
    • ローカルで MongoDB を動かしても良いですが、MongoDB Atlas の無料枠でも問題ありません
  • リポジトリを Fork する
  • .env.example を元に .env ファイルを設置する
  • npm ci で依存関係をインストールする
    • npm install はなるべく使わないでください
  • npm run dev で開発サーバーを起動する
  • npm run lint で ESLint による lint を実行する
  • npm test で jest によるテストを実行する

バッチジョブの実行

以下のバッチジョブが存在します

  • npm run job:river
    • 河川の氾濫情報を収集します
  • npm run job:dispatch
    • 消防緊急出動の情報を収集します
  • npm run job:massmedia
    • マスメディアのニュース記事を収集します
  • npm run job:hatebu
    • はてなブックマークからニュース記事を収集します

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.