Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Oct 29, 2024. It is now read-only.

samtgarson/micro-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

18 Commits

Repository files navigation

Micro Starter

A Node microservice starter kit

Basic starter kit for a Node microservice using Micro and other modern JS-y things.

[Deprecated] Since micro v8 was released, the recommended dev setup is micro-dev. Good job team Zeit! πŸ”₯

XO code style npm npm

What do I get

  • πŸ”· Micro for no fluff HTTP serving
  • πŸ“¦ Webpack for bundling with ES7 syntax
  • πŸƒ Jest for speedy and easy to write tests
  • ❀️ XO for no fuss linting
  • πŸ€“ Development setup including file watching and server restarting for happy devs

Tell me more

Usage

yarn global add micro-starter
micro-start my-app-name # create a new project directory ready for microservicing

Helpers

  • yarn dev: Run development server to watch your files
  • yarn build: Build for production
  • yarn start: Run application

Testing

  • yarn test:spec: Run tests with Jest
  • yarn test:lint: Lint your code with XO
  • yarn test: Run it all

Environment

Use build/env.js for env vars in development but don't check it into source control! You can keep build/env.example.js updated with the dummy environmental requirements of your app for other devs.


Use micro-starter?

Let people know on your readme! πŸ‘‰ made with micro-starter πŸ‘ˆ

[![made with micro-starter](https://img.shields.io/badge/kit-micro--starter-3986fe.svg)](https://github.com/samtgarson/micro-starter)

Contribute

Please open issues/PRs. Thanks.

Happy microservicing.

About

[Deprecated] πŸ”· Basic (opinionated) starter kit for a micro app with webpack build

Topics

Resources

Stars

Watchers

Forks

Packages

Contributors

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /