Prepare guide for development environment

Author: velopert

.env.development

@@ -2,9 +2,9 @@ PORT=5000
 
 TYPEORM_CONNECTION=postgres
 TYPEORM_HOST=localhost
-TYPEORM_USERNAME=velognext
-TYPEORM_PASSWORD=velognext
-TYPEORM_DATABASE=velognext
+TYPEORM_USERNAME=velog
+TYPEORM_PASSWORD=velogpw
+TYPEORM_DATABASE=velog
 TYPEORM_PORT=5432
 TYPEORM_SYNCHRONIZE=false
 TYPEORM_LOGGING=true
@@ -21,4 +21,6 @@ FACEBOOK_ID=686892251796798
 FACEBOOK_SECRET=339f16ee1f3d011e927410193ed594ec
 GOOGLE_ID=997152497044-0kq4paur2i6rq9aibjp5jjlapc32eek2.apps.googleusercontent.com
 GOOGLE_SECRET=26ZmeLM5aRx4VPPF88j8UieP
-HASH_KEY=SampleHashKey
+HASH_KEY=SampleHashKey
+API_HOST=localhost:5000
+CLIENT_HOST=localhost:3000

README.md

@@ -0,0 +1,28 @@
+# velog-server
+
+Velog is a blog platform for developers. It provides markdown editor with syntax highlighter enabled. Currently, this service only supports Korean language.
+
+Website link: https://velog.io/
+
+Frontend project of service is at another Repo - [velog-client](https://github.com/velopert/velog-server)
+
+## Project Stack
+- Node.js
+- TypeScript
+- Apollo GraphQL
+- PostgreSQL
+- TypeORM
+- Redis
+- ElasticSearch
+- Koa
+- Serverless
+- AWS
+  - Lambda
+  - SES
+  - API Gateway
+  - S3
+  - Cloudfront
+
+## Running on your machine
+
+[Link](https://github.com/velopert/velog-server/wiki/Running-on-your-machine)

docker/postgresql/.gitignore

@@ -0,0 +1 @@
+docker

docker/postgresql/docker-compose.yml

@@ -0,0 +1,16 @@
+version: '3.1'
+
+services:
+
+  db:
+    container_name: postgres
+    image: postgres
+    restart: always
+    environment:
+      POSTGRES_PASSWORD: postgrespw
+    ports:
+      - "5432:5432"
+    command: postgres -c max_connections=1000
+    volumes:
+      - ./docker/data:/var/lib/postgresql/data
+      - ./../../init.sql:/docker-entrypoint-initdb.d/init.sql

docker/redis/Dockerfile

@@ -0,0 +1,2 @@
+FROM bitnami/redis:5.0
+ENV ALLOW_EMPTY_PASSWORD=yes

docker/redis/docker-compose.yml

@@ -0,0 +1,16 @@
+version: '2'
+
+services:
+  redis:
+    image: 'bitnami/redis:5.0'
+    environment:
+      # ALLOW_EMPTY_PASSWORD is recommended only for development.
+      - ALLOW_EMPTY_PASSWORD=yes
+    ports:
+      - '6379:6379'
+    volumes:
+      - 'redis_data:/bitnami/redis/data'
+
+volumes:
+  redis_data:
+    driver: local

schema.sql renamed to init.sql

@@ -1,3 +1,14 @@
+CREATE DATABASE velog
+  LC_COLLATE 'C'
+  LC_CTYPE 'C'
+  ENCODING 'UTF8'
+  TEMPLATE template0;
+
+CREATE USER velog WITH ENCRYPTED PASSWORD 'velogpw';
+GRANT ALL PRIVILEGES ON DATABASE velog to velog;
+
+\c velog
+
 --
 -- PostgreSQL database dump
 --
@@ -1190,13 +1201,6 @@ CREATE INDEX users_email ON public.users USING btree (email);
 CREATE INDEX users_username ON public.users USING btree (username);
 
 
---
--- Name: posts tsvectorupdate; Type: TRIGGER; Schema: public; Owner: velog
---
-
-CREATE TRIGGER tsvectorupdate BEFORE INSERT OR UPDATE ON public.posts FOR EACH ROW EXECUTE PROCEDURE public.posts_tsv_trigger();
-
-
 --
 -- Name: tag_alias FK_38921256eca6f24170411db8ac7; Type: FK CONSTRAINT; Schema: public; Owner: velog
 --

src/env.ts

@@ -4,5 +4,5 @@ import path from 'path';
 const { NODE_ENV } = process.env;
 
 dotenv.config({
-  path: path.resolve(process.cwd(), NODE_ENV === 'development' ? '.env' : '.env')
+  path: path.resolve(process.cwd(), NODE_ENV === 'development' ? '.env.development' : '.env')
 });

src/routes/api/v2/auth/index.ts

@@ -52,11 +52,24 @@ auth.post('/sendmail', async ctx => {
     await getRepository(EmailAuth).save(emailAuth);
     const emailTemplate = createAuthEmail(!!user, emailAuth.code);
 
-    await sendMail({
-      to: email,
-      ...emailTemplate,
-      from: '[email protected]'
-    });
+    try {
+      if (process.env.NODE_ENV === 'development') {
+        console.log(
+          `Login URL: http://${process.env.CLIENT_HOST}/${user ? 'email-login' : 'register'}?code=${
+            emailAuth.code
+          }`
+        );
+      }
+      await sendMail({
+        to: email,
+        ...emailTemplate,
+        from: '[email protected]'
+      });
+    } catch (e) {
+      if (process.env.NODE_ENV !== 'development') {
+        throw e;
+      }
+    }
 
     ctx.body = {
       registered: !!user

src/routes/api/v2/auth/social/social.ctrl.ts

@@ -395,7 +395,7 @@ export const socialCallback: Middleware = async ctx => {
 
     const redirectUrl =
       process.env.NODE_ENV === 'development'
-        ? 'https://localhost:3000/register?social=1'
+        ? 'http://localhost:3000/register?social=1'
         : 'https://velog.io/register?social=1';
     ctx.redirect(encodeURI(redirectUrl));
   } catch (e) {