improved readibility and removed unused code

Author: saurabh1907

README.md

@@ -6,7 +6,7 @@ It includes but is not limited to the following -
 * Complete PostgreSQL database support with sample db, model and dummy data examples included in the project.
 * Reverse proxy using nginx.
 * RedisQueue with Celery for asynchronous process 
-
+* There are two branches: master and frontend_backend_db_docker. Use the latter for a simpler skeleton code.
 <p>All components created from Docker images that expand on the respective official images from Docker Hub. Docker-compose file binds them together </p>
 
 ## Working
@@ -17,10 +17,9 @@ Prerequisites [here](https://github.com/angular/angular-cli#prerequisites).
 
 ## How to run
 - Clone this repository
-There are two branches- master and frontend_backend_db_docker. use -> git checkout branch_name
 - Then navigate to project_dir and execute following commands:
   - `docker-compose build`
-  - `docker-compose up`
+  - `docker-compose up` Note: use `npm install` in frontend directory for the first time
   - _OR_ just run one command: `docker-compose -f docker-compose.yml up --build`
 
 - Open Browser and type following URL:
@@ -44,6 +43,7 @@ There are two branches- master and frontend_backend_db_docker. use -> git checko
 -   The project structure supports multiple environments defined in setting.py
 -   Edit environment variables in .env and .env_docker
 -   ENV variables are loaded through setting.py
+-   (Angular) This is a development setup; For Prod use nginx server to host the contents of dist folder (`ng build --prod`)
 -   Some helpful commands are provided in Makefile
      - Eg. make backend-access
 - docker-compose-local.yml has just postgresql and redis

backend/app/celery/__init__.py

@@ -1,11 +1,12 @@
 from celery import Celery
 
+
 def create_celery(app_name=__name__):
     return Celery(app_name, broker='redis://localhost:6379/0')
 
+
 def init_celery(celery, app):
     celery.conf.update(app.config)
-    # celery.config_from_object(app.config)
     TaskBase = celery.Task
 
     class ContextTask(TaskBase):

backend/app/celery/celery_worker.py

@@ -5,14 +5,14 @@
 
 
 @celery.task()
-def add_dummy_blogs(count, duration):
+def add_dummy_blogs(count):
     for i in range(0, count):
         blog_service.save(Blog("A blog from Celery", "A content from Celery"))
     return "Task Complete"
 
+
 app = create_app(env='celery')
 CORS(app, origins='*')
-# app.app_context().push()
 
 
 # Run Using

backend/app/models/blog.py

@@ -10,7 +10,8 @@ class Blog(db.Model):
     id = db.Column(db.Integer, primary_key=True, autoincrement=True)
     title = db.Column(db.String(500), nullable=False)
     description = db.Column(db.Text, nullable=False)
-    created_date = db.Column(db.DateTime, nullable=False,)
+    created_date = db.Column(db.DateTime, nullable=False, )
+
     # password_hash = db.Column(db.String(128)
 
     def __init__(self, title, description):
@@ -23,13 +24,12 @@ def as_dict(self):
         return {c.key: getattr(self, c.key)
                 for c in inspect(self).mapper.column_attrs}
 
-    #another alternate to using as_dict
+    # another alternate to using as_dict
     # @property
     # def serialize(self):
     #     return {
     #         'title': self.title,
     #         'description': self.description,
-    #         'created_date': self.reated_date,
+    #         'created_date': self.created_date,
     #         'id': self.id,
     #     }
-

backend/app/services/blog_service.py

@@ -5,8 +5,11 @@
 
 
 class BlogService(SQLAlchemyService):
-    __model__ = Blog
-    __db__ = db
+    model = Blog
+    db = db
+
+    def __init__(self):
+        SQLAlchemyService.__init__(self, self.db, self.model)
 
     def update(self, id, title, desc):
         to_update = self.__model__.query.get(id)

backend/app/services/sql_alchemy_service.py

@@ -3,37 +3,38 @@
 
 
 class SQLAlchemyService:
-    __db__ = None
-    __model__ = None
 
+    def __init__(self, db, model):
+        self.db = db
+        self.model = model
+
+    # Optional: validation before insert in db
     #     def _isinstance(self, obj, raise_error=True):
     #         rv = isinstance(obj, self.__model__)
     #         if not rv and raise_error:
     #             raise ValueError('%s is not of type %s' % (obj, self.__model__))
     #         return rv
+
     def all(self):
-        data = self.__model__.query.all()
+        data = self.model.query.all()
         data_dict = [row.as_dict() for row in data]
         return jsonify(data_dict)
 
     def get(self, id):
-        data = self.__model__.query.get(id)
+        data = self.model.query.get(id)
         return jsonify(data.as_dict())
 
     def get_all(self, *ids):
-        return self.__model__.query.filter(self.__model__.id.in_(ids)).all()
+        return self.model.query.filter(self.model.id.in_(ids)).all()
 
     def save(self, obj):
-        # self._isinstance(obj)
-        self.__db__.session.add(obj)
-        self.__db__.session.commit()
-        # return jsonify(obj.as_dict())
+        # self._isinstance(obj) # validation
+        self.db.session.add(obj)
+        self.db.session.commit()
         return 1
 
     def delete(self, id):
-        to_delete = self.__model__.query.get(id)
-        self.__db__.session.delete(to_delete)
-        self.__db__.session.commit()
+        to_delete = self.model.query.get(id)
+        self.db.session.delete(to_delete)
+        self.db.session.commit()
         return jsonify(to_delete.as_dict())
-
-

backend/app/views/views.py

@@ -1,10 +1,11 @@
-from flask_restful import Resource, reqparse, abort
+from flask_restful import Resource, abort
 from flask import request
 from app.models.blog import Blog
 from app.services.blog_service import BlogService
 
 blog_service = BlogService()
 
+
 def register_view(api):
     api.add_resource(BlogListApi, '/api/blogs')
     api.add_resource(BlogApi, '/api/blogs/<int:id>')
@@ -42,36 +43,10 @@ def put(self, id):
     def delete(self, id):
         return blog_service.delete(id)
 
-    # def __init__(self):
-    # validation example
-    # self.reqparse = reqparse.RequestParser()
-    # self.reqparse.add_argument('title', type = str, location = 'json', required = True,
-    #     help = 'No title provided')
-    # self.reqparse.add_argument('description', type = str, location = 'json', required = True,
-    #     help = 'No description provided')
-    # self.reqparse.add_argument('blog_id', type = int, location = 'json')
-
 
 class DummyBlogs(Resource):
     def post(self):
         num = int(request.data.decode("utf-8"))
         from app.celery.celery_worker import add_dummy_blogs
-        add_dummy_blogs.apply_async(args=[num, 10], countdown=10)
+        add_dummy_blogs.apply_async(args=[num], countdown=10)
         return success_response()
-
-# Routes approach to create api
-# @app.route('/')
-# @app.route('/index')
-# def index():
-#     user = {'username': 'Saurabh'}
-#     posts = [
-#         {
-#             'author': {'username': 'John'},
-#             'body': 'Beautiful day in Portland!'
-#         },
-#         {
-#             'author': {'username': 'Susan'},
-#             'body': 'The Avengers movie was so cool!'
-#         }
-#     ]
-#     return render_template('index.html', title='Home', user=user, posts=posts)

frontend/Dockerfile

@@ -3,15 +3,15 @@ RUN apk update && apk add --no-cache make git
 
 WORKDIR /frontend
 
-COPY package.json package-lock.json /frontend/
-
 RUN npm i npm@latest -g && \
-    npm install -g @angular/cli@7.3.9
+    npm install -g @angular/cli@8.2.14
 
-RUN chown -R node /frontend
+## (Optional) To copy everything from frontend to server. Since we are using volume mount (to support live reload) its not needed
+#COPY . /frontend
+#RUN npm install
 
-WORKDIR /frontend
+RUN chown -R node /frontend
 
 USER node
 
-RUN npm install
+

frontend/karma.conf.js

@@ -26,7 +26,7 @@ module.exports = function (config) {
     colors: true,
     logLevel: config.LOG_INFO,
     autoWatch: true,
-    browsers: ['Firefox'],
+    browsers: ['Chrome'],
     singleRun: false,
     restartOnFileChange: true
   });