Nanum

Overview

Nanum's key function is development project management. When the user creates a project and modifies the source, the results are reflected on the server. The project team members can modify the project source code in real time and know who is currently accessing to modify which source.

In addition, we aim to use the docker to operate the Nanum service in a host independent environment.

Feature

Project Management

• Project source code real-time synchronization support

Dockerizing

• Provide docker feature supporting above function (see How to Run it)

Demo

youtube

website

Documents

• How to Run it
  • Deploy app container in AWS or local machine
  • Develop & Test in local machine
• Roadmap
• Contribution Guide

How to Run it

Things that must be installed. (The stated version is the version our team tested.)

• npm >= 5.6.0
• node >= 8.9.4
• jdk8
• docker >= 18.02.0-ce
• docker-compose >= 1.8.0
• gradle >= 3.5.1

1. Deploy app container in AWS or local machine

   • clone Nanum project

   $ git clone https://github.com/LandvibeDev/Nanum
   $ cd Nanum
   $ git checkout develop
   $ git pull origin develop
   

   • Build front project

     $ cd front
     $ npm install
     $ npm run build
     

   • Copy Dockerfile for server(server/Dockerfile)

     • copy Dockerfile.template to Dockerfile

   • Edit Dockerfile for mysql container (server/mysql/Dockerfile)

     • copy Dockerfile.template to Dockerfile

     FROM mysql
     ENV MYSQL_USER="username"
     ENV MYSQL_DATABASE="dbname"
     ENV MYSQL_CONTAINER_NAME="container-name"
     ENV MYSQL_ROOT_PASSWORD="root-password"
     ENV MYSQL_PASSWORD="passwoad"
     

   • Get IP

     • when deploying AWS: Get Public DNS(IPv4) of you AWS ec2 instance
     • e.g. ec2-xx-xxx-xxx.xx.ap.compute.amazon.com

     

     • when deploying local machine: Get ip information of your machine
     • e.g. 10.0.x.x, 192.168.x.x

     ​

   • You can skip the following steps Make Client ID for Google Cloud Platform through Simple Login.

     

   • Make Client ID for Google Cloud Platform

     • Access https://console.cloud.google.com/apis/credentials

     • Make Oauth Client ID

       

     • select WebApplication

     • type :

     • type :/login/google/oauth2callback

       

     • get Client ID, Client Secret (Never reveal the client secret!)

       

   • Edit application.yml (server/src/main/resources/application.yml)

     • copy application.yml.templete to application.yml
     • edit datasource (Match the information with Dockerfile for mysql)

      datasource:
        url: # jdbc:mysql://mysql:3306/<db name>
        username: # <username>
        password: # <passward>
     

     • edit resources.static-locations

      resources:
        static-locations: file:/front/  # use this when deploy
     

     • edit project.code-location
       • set location for source code of project whatever you want

     project:
      code-location: /resource
     

     • edit login.google (client-id, client-secret, redirect-uri)

     login:
       google:
         client-id : # <client-id>
         client-secret : # <cilent-secret>
         redirect-uri : # http://<ip>:8080/login/google/oauth2callback
     

   • edit docker-compose.yml (server/docker-compose.yml)

     • copy docker-compose.yml.template to docker-compose.yml

     version: "2"
     
     services:
         app:
             container_name: app
             build: .
     
             # we can set environment
             ports:
                 - 8080:8080
             links:
                 - mysql:mysql
             volumes:
                 - ../front/dist:/front
                 - ../resource:/resource
     
         mysql:
             container_name: mysql
             build: ./mysql
             ports:
                 - 3306
             volumes:
             - ./mysql/mysql:/var/lib/mysql
             - ./mysql/option.cnf:/etc/mysql/conf.d/option.cnf
     
     

   • Run the following shell script

     $ cd Nanum/server
     $ ./gradlew build -x test
     ----------------------------------------------------
     :compileJava UP-TO-DATE
     :processResources UP-TO-DATE
     ...
     BUILD SUCCESSFUL
     
     Total time: 5.305 secs
     ----------------------------------------------------
     
     $ sudo docker-compose build
     ----------------------------------------------------
     Building mysql
     Building app
     Step 1/6 : FROM mysql
     ...
     Successfully built 95843209de9c
     Successfully tagged server_app:latest
     ----------------------------------------------------
     
     # Build the image and run the service according to the contents of the docker-compose.yml file.
     $ docker-compose up
     ----------------------------------------------------
     Creating mysql ...
     Creating app ...
     ...
     ----------------------------------------------------
     
     # Clear the service. Deletes containers and networks, and clears volumes according to options.
     $ docker-compose down
     ----------------------------------------------------
     Stopping mysql ... done
     Stopping app ... done
     ...
     ----------------------------------------------------
     
     # Shows the services running in the current environment.
     $ docker-compose ps
           Name               Command               State            Ports          
      ------------------------------------------------------------------------
      app     java -Djava.security.egd=f ...   Up      0.0.0.0:8080->8080/tcp  
      mysql   docker-entrypoint.sh mysqld      Up      0.0.0.0:32768->3306/tcp
     

   • connect to :8080

     ​

Roadmap

Project Management

• Project source code real-time synchronization support
• Project build support

chatting

• Chat support between project members

Issue Management

• Mark-down form support

Contribution Guide

Fill the templete of issues or PRs.

Dependency

• sockjs-client
• stomp-websocket
• mysql-connector-j
• springfox
• axios
• vue
• vuex
• vue-material

Bug Report

If you find a bug, please report to us posting issues on GitHub.

License

Nanum is licensed under the GPLv2 License. See LICENSE and NOTICE for full license information