Skip to content

Commit 509513b

Browse files
committed
Add prettier. Improve README
1 parent d8c1acf commit 509513b

File tree

3 files changed

+32
-3
lines changed

3 files changed

+32
-3
lines changed

.prettierignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules/**
2+
android/**
3+
ios/**
4+
__tests__/**

.prettierrc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"printWidth" : 100,
3+
"tabWidth" : 2,
4+
"useTabs" : false,
5+
"semi" : true,
6+
"singleQuote" : true,
7+
"trailingComma" : "es5",
8+
"bracketSpacing" : true,
9+
"jsxBracketSameLine" : false,
10+
"arrowParens" : "always",
11+
"rangeStart" : 0,
12+
"requirePragma" : false,
13+
"insertPragma" : false,
14+
"proseWrap" : "preserve"
15+
}
16+

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Introduction
2-
This is a typescript koa project, with docker, docker compose, error handlers, test, prettier, eslint set up
2+
This is a typescript koa project with the following features:
3+
* docker with multi stage build for development and production
4+
* docker compose for development
5+
* error handlers
6+
* tests with mocha and sinon
7+
* prettier
8+
* eslint
39

410
# Setup
511
## Install required tools
@@ -14,13 +20,16 @@ This is a typescript koa project, with docker, docker compose, error handlers, t
1420
* `COOKIE_SECRET=mycookiesecret`
1521
* `NODE_ENV=development`
1622

17-
# Running the project
23+
# Using the project
1824
**Run in development mode**
1925
* Build: `docker-compose build`
2026
* Start: `docker-compose up -d`
21-
* Server is available at: `localhost:6001`
27+
* Server is available at: `localhost:3000`
2228
* Stop: `docker-compose down`
2329

30+
**Build production image**
31+
* `npm run docker-build-prod`
32+
2433
# Note
2534
Whenever new packages are added via `npm install`:
2635
* You need to stop the service: `docker-compose stop <service>` or `docker-compose down`

0 commit comments

Comments
 (0)