Git Product home page Git Product logo

jaebook-server's Introduction

❯ JaeBook Server

Using TypeScript and Express.

Frontend : JaeBook Client

Article

Project Features

  • Express with TypeScript
  • Structure Beautiful structure of controller, service, repository, model, middleware.
  • TypeORM highly influenced by other ORMs, such as Hibernate, Doctrine and Entity Framework.
  • TypeDI Dependency Injection for TypeScript.
  • Routing-Controllers Structured, declarative, and beautifully configured class-based controller.
  • Helmet Basic Security Features.
  • JWT JWT security strategy using AccessToken, RefreshToken.
  • Jest, SuperTest Unit Testing and E2E testing.
  • Sentry, Winston Error logging and monitoring.
  • Swagger API endpoint documentation.
  • ESLint Find and fix problems in your TypeScript code.
  • Prettier Prettier is an opinionated code formatter.
  • Docker Docker provides a simple and powerful developer experience, workflows and collaboration for creating applications.

Unit Testing and E2E testing

Test using In-memory Database.

jaebook-unit-e2e-testing

Error logging and monitoring

sentry-error-log

winston-error-log

Swagger

jaebook-swagger-first

jaebook-swagger-second

Coding style automation with ESLint, Prettier and VSCode

By setting options for your team, you can keep your team's coding style consistent.

eslint-prettier

GitHub Action and Codecov

github-action

codecov

Environment Variable Management

APP

Edit from .env.{NODE_ENV}.sample in jaebook-server/config to .env.{NODE_ENV} and replace the content.

# APPLICATION
PORT=3000
API_PREFIX=/api

# MySQL DATABASE
DATABASE_HOST=127.0.0.1
DATABASE_PORT=3306
DATABASE_USERNAME=development
DATABASE_PASSWORD=development
DATABASE_NAME=development

# TypeORM
TYPEORM_SYNCHRONIZE=true
TYPEORM_LOGGING=true

# JWT
JWT_SECRET_ACCESS_KEY=test!@#$
JWT_SECRET_REFRESH_KEY=retest!@#$

# Swagger
SWAGGER_ROUTE=/api-docs

# Sentry
SENTRY_DSN=

Docker

Edit from .env.sample in the root to .env and replace the content. This is the environment variable setting to be used for Docker.

# Set docker-compose environment
DB_ROOT_PASSWORD=testpass
DB_USER=test
DB_PASSWORD=test
DB_NAME=jaebook

Build Setup

Steps to run this project:

  1. Run yarn install command
  2. Run docker-compose up command

Development

  1. Run yarn install command
  2. Run yarn dev command

Tests

# e2e, unit tests
$ yarn test

jaebook-server's People

Contributors

dependabot[bot] avatar jhyeok avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

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.