https://github.com/samtgarson/micro-starter

[Deprecated] 🔷 Basic (opinionated) starter kit for a micro app with webpack build
https://github.com/samtgarson/micro-starter

cli javascript jest micro microservice node starter webpack

Last synced: 3 months ago
JSON representation

[Deprecated] 🔷 Basic (opinionated) starter kit for a micro app with webpack build

• Host: GitHub
• URL: https://github.com/samtgarson/micro-starter
• Owner: samtgarson
• Created: 2017-01-18T21:30:31.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-16T20:12:34.000Z (over 6 years ago)
• Last Synced: 2024-03-18T03:21:43.722Z (3 months ago)
• Topics: cli, javascript, jest, micro, microservice, node, starter, webpack
• Language: JavaScript
• Homepage:
• Size: 74.2 KB
• Stars: 141
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Lists

• awesome-list-microservice - micro-starter

README

        
# Micro Starter

> A Node microservice starter kit

Basic starter kit for a Node microservice using [Micro](https://github.com/zeit/micro) and other modern JS-y things.

**[Deprecated]** Since [micro](https://github.com/zeit/micro) v8 was released, the recommended dev setup is [micro-dev](https://github.com/zeit/micro-dev). Good job team Zeit! 🔥

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) [![npm](https://img.shields.io/npm/dt/micro-starter.svg)](https://www.npmjs.com/package/micro-starter) [![npm](https://img.shields.io/npm/v/micro-starter.svg)](https://www.npmjs.com/package/micro-starter)

## What do I get

- 🔷 [Micro](https://github.com/zeit/micro) for no fluff HTTP serving

- 📦 [Webpack](https://webpack.github.io/) for bundling with ES7 syntax

- 🃏 [Jest](https://github.com/facebook/jest) for speedy and easy to write tests

- ❤️ [XO](https://github.com/sindresorhus/xo) for no fuss linting

- 🤓 Development setup including file watching and server restarting for happy devs

## Tell me more

### Usage

```bash

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](https://img.shields.io/badge/kit-micro--starter-3986fe.svg)](https://github.com/samtgarson/micro-starter)  👈

```md

[![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.