Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hongymagic/k2
Koa2 API template with passport, GraphQL, flowtype, knex and more.
https://github.com/hongymagic/k2
flowtype graphql jest knex koa2 koa2-start nodejs passport postgresql starter-kit
Last synced: 3 months ago
JSON representation
Koa2 API template with passport, GraphQL, flowtype, knex and more.
- Host: GitHub
- URL: https://github.com/hongymagic/k2
- Owner: hongymagic
- Created: 2017-05-23T12:25:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-26T19:11:57.000Z (over 6 years ago)
- Last Synced: 2024-07-05T14:15:07.005Z (4 months ago)
- Topics: flowtype, graphql, jest, knex, koa2, koa2-start, nodejs, passport, postgresql, starter-kit
- Language: JavaScript
- Size: 712 KB
- Stars: 49
- Watchers: 4
- Forks: 3
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-koa - K2 - Koa2, Babel ES6/7, GraphQL, passport-local based authentication, PostgreSQL, Jest for Unit and Integration testing and more (Examples & Boilerplates)
README
# K2
[](https://travis-ci.org/hongymagic/k2) [](https://codecov.io/gh/hongymagic/k2)  [](https://www.codacy.com/app/hongymagic-github/k2?utm_source=github.com&utm_medium=referral&utm_content=hongymagic/k2&utm_campaign=Badge_Grade)
Koa 2 and GraphQL server that _just works™_. We've climbed the mountain of
boilerplate for you, so you don't have to.
## Included…
- [koa2](http://koajs.com) - write stuff in middleware
- [babel](http://babeljs.io) - use latest ES6/7 features today. why wait?
- [passport.js](http://passportjs.org) - easy authentication
- [knex.js](http://knexjs.org) - documentation is better than sequelize
- [GraphQL](http://graphql.org) - it's the way to go
- [Jest](https://facebook.github.io/jest/) - don't let tests get in your way
- [ramda](http://ramdajs.com) - please don't use lodash or underscore
- [prettier](https://prettier.github.io/prettier/) - don't worry about formatting…
- [flowtype](https://flow.org) - get your types right
## Getting started
Make sure you have Docker installed as PostgreSQL is run on the docker
container.
```
git clone -o k2 -b master --single-branch https://github.com/hongymagic/k2.git example-api
cd example-api # Change current directory to the newly created one
yarn install # Install required packages via yarn
cp .env.sample .env # Configuration on development mode is done via dotenv
yarn migrate:latest # Run database migrations
yarn seed:run # Add some seed data
yarn start:dev # Start the server in development mode
```
By default the API server starts on port 5000, http://localhost:5000.
## Structure
```
┌── .env.sample # Sample .env file loaded into process.env
├── docker-compose.yml # Auxiliary services such as postgresql via docker
├── knexfile.js # Configuration for knex.js
├── migrations/ # Database migrations. See below for more info
├── seeds/ # Database seeds. See below for more info
├── tests/ # Integration tests using supertest
├── sqlite3/ # SQLite3 database location
└── src/
├── db.js # DB instance used by the app and/or models
├── models/ # ORM models written in ES6 classes
├── middleware/ # Custom middleware to be used by modules
├── modules/ # Route-Controller pair for koa2
│ ├── auth/ # Sample /authenticate module
│ ├── graphql/ # GraphQL
│ └── index.js # Don't touch this
├── passport.js # Passport.js configuration using passport-local
├── DataLoader.js # Data fetching layer for GraphQL
├── schema.js # GraphQL schema
└── types/ # GraphQL types
```
## Testing
K2 uses [Facebook Jest](https://facebook.github.io/jest/) so you can add a
directory named `__tests__` at any level and start writing tests.
Root level `tests` directory is reserved for integration tests using supertest.
Currently requires you to run the database server via docker-compose: see above.
```
yarn test # Run all tests including unit and integration tests
yarn test:unit # Only run unit tests inside src/ directory
yarn test:integration # Only run integration tests inside tests/ directory
yarn test:coverage # Generate coverage report. Also travis default
```
## Deployments
This is a standard Node.js version 8.0+ application. You can deploy it to
anywhere you like including, but not limited to:
- [now.sh](https://zeit.co/now)
- [AWS Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk/)
- Pretty much anything that runs docker or Node.js
### Now.sh
Deploying to now is super simple if you're using SQLite3 (default). Just run:
```
now
```
### AWS ElasticBeanstalk
Simply create a version of AWS EB with Node version 8.0.1 and deploy. I
personally have travis CI deploy it via a `eb` script.
- TODO: Sample `.ebextensions/`
- Database is already configured to prefer `RDS_{HOSTNAME,DB_NAME,USERNAME,PASSWORD}` connection information