initiated the boiler plate

Author: manav1403

.dockerignore

@@ -0,0 +1,16 @@
+**/*.pyc
+**/*.pyo
+**/*.log
+**/*.egg-info
+**/__pycache__
+.venv/
+
+**/node_modules/
+.travis.yml
+.env
+.env.example
+.git/
+.gitignore
+.idea/
+.gitmodules
+db.sqlite3

.env.example

@@ -0,0 +1,16 @@
+SECRET_KEY='dcyz)+52d)n1f3d6dsf&g0p6a($(v4&rvu=9u3u6fib9=kzy$8'
+ALLOWED_HOSTS=*
+DEBUG=True
+
+# Database configs
+
+DB_NAME=roboweb
+DB_USER=robouser
+DB_PASSWORD=password
+
+# Email configs
+
+SERVER_EMAIL=noreply@localhost.com
+SERVER_EMAIL_PASSWORD=password
+
+# other configs

.gitignore

@@ -0,0 +1,149 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+*.sqlite3
+**/migrations/*
+!**/migrations/__init__.py
+staticfiles/
+media/
+.idea/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.DS_Store
+
+
+# Database
+tadb
+db.sqlite3
+
+# VueJS files
+node_modules/
+/dist/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+/test/unit/coverage
+/test/e2e/reports
+selenium-debug.log
+ui/src/config/index.js
+
+# Editor directories and files
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+
+npm-debug.log
+yarn-error.log
+
+# Editor directories and files
+*.sln.DS_Store
+node_modules
+/dist
+
+/tests/e2e/videos/
+/tests/e2e/screenshots/
+
+# local env files
+.env.local
+.env.*.local
+
+# Editor directories and files
+.vscode
+*.sw?

.travis.yml

@@ -0,0 +1,26 @@
+language: python
+python:
+  - "3.6"
+addons:
+  postgresql: "9.6"
+dist: xenial
+before_script:
+  - cp .env.example .env
+  - psql -c "CREATE DATABASE robodb;" -U postgres
+  - psql -c "CREATE USER robouser WITH LOGIN PASSWORD 'password';" -U postgres
+  - psql -c "ALTER ROLE robouser WITH CREATEDB;" -U postgres
+  - psql -c "GRANT ALL PRIVILEGES ON DATABASE robodb TO robouser;" -U postgres
+before_install:
+  - export DJANGO_SETTINGS_MODULE=config.settings
+install:
+  - pip3 install pipenv
+  - pipenv install --dev
+script:
+  - source "$(pipenv --venv)"/bin/activate
+  - cd backend
+  - flake8 .
+  - python manage.py makemigrations
+  - python manage.py migrate
+  - cd ../frontend
+  - npm install
+  - npm run build

Makefile

@@ -0,0 +1,21 @@
+BUILD_NAME=robotics-web
+BUILD_TAG=$$(git log -1 --pretty=%h)
+
+build:
+	@docker build -t ${BUILD_NAME}-backend:${BUILD_TAG} -t ${BUILD_NAME}-backend:latest -f backend/Dockerfile backend
+	@docker build -t ${BUILD_NAME}-frontend:${BUILD_TAG} -t ${BUILD_NAME}-frontend:latest -f frontend/Dockerfile frontend
+
+.env:
+	@cp .env.example .env
+
+dev-start: .env
+	@docker-compose up -d
+
+dev-stop:
+	@docker-compose down
+
+dev-logs:
+	@docker-compose logs -f
+
+exec:
+	@docker exec -it $$(echo "$$(docker ps --filter "name=django")" | awk 'NR > 1 {print $$1}') sh

README.md

@@ -1,2 +1,35 @@
-# web-portal
-The source code for the robotics club website.
+## Getting Started
+
+Ensure that you have installed [Docker](https://docs.docker.com/install/) (with [Docker Compose](https://docs.docker.com/compose/install/)).
+
+Run the development server:
+```
+cd <project_directory_name>
+make dev-start
+```
+
+After executing `make dev-start`, you will be running:
+* The application on http://localhost:8080 
+* The API Server on http://localhost:8000
+
+Make database migrations: 
+```
+make exec
+python manage.py makemigrations
+python manage.py migrate
+```
+
+Create a superuser: 
+```
+make exec
+python manage.py createsuperuser
+```
+
+View logs of docker containers: 
+```
+make dev-logs
+```
+
+To stop the development server: 
+```
+make dev-stop

backend/.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 130

backend/Dockerfile

@@ -0,0 +1,28 @@
+FROM python:3.6-alpine AS base
+
+ENV PYROOT /pyroot
+ENV PYTHONUSERBASE $PYROOT
+
+# Build Container
+FROM base AS builder
+ARG BUILD_DEPS="gcc python3-dev musl-dev postgresql-dev"
+RUN apk --no-cache add ${BUILD_DEPS}
+RUN pip install pipenv
+COPY Pipfile* ./
+RUN PIP_USER=1 PIP_IGNORE_INSTALLED=1 pipenv install --system --deploy \
+    && find /usr/local \
+        \( -type d -a -name test -o -name tests \) \
+        -o \( -type f -a -name '*.pyc' -o -name '*.pyo' \) \
+        -exec rm -rf '{}' \+
+
+# Runtime Container
+FROM base
+ARG RUNTIME_DEPS="libcrypto1.1 libssl1.1 libpq"
+RUN apk --no-cache add ${RUNTIME_DEPS}
+COPY --from=builder $PYROOT/lib/ $PYROOT/lib/
+RUN pip install gunicorn
+
+WORKDIR /app
+COPY . /app
+
+CMD gunicorn -b :$PORT config.wsgi

backend/Dockerfile.prod

@@ -0,0 +1,32 @@
+FROM python:3.6-alpine AS base
+
+ENV PYROOT /pyroot
+ENV PYTHONUSERBASE $PYROOT
+
+# Build Container
+FROM base AS builder
+ARG BUILD_DEPS="gcc python3-dev musl-dev postgresql-dev"
+RUN apk --no-cache add ${BUILD_DEPS}
+RUN pip install pipenv
+COPY Pipfile* ./
+RUN PIP_USER=1 PIP_IGNORE_INSTALLED=1 pipenv install --system --deploy \
+    && find /usr/local \
+        \( -type d -a -name test -o -name tests \) \
+        -o \( -type f -a -name '*.pyc' -o -name '*.pyo' \) \
+        -exec rm -rf '{}' \+
+
+# Runtime Container
+FROM base AS dep-stage
+ARG RUNTIME_DEPS="libcrypto1.1 libssl1.1 libpq"
+RUN apk --no-cache add ${RUNTIME_DEPS}
+COPY --from=builder $PYROOT/lib/ $PYROOT/lib/
+RUN pip install gunicorn
+
+WORKDIR /app
+COPY . /app
+RUN ls
+RUN python manage.py collectstatic --no-default-ignore
+CMD gunicorn -b :8000 config.wsgi
+
+# production stage
+#FROM nginx:stable-alpine as production-stage

backend/Pipfile

@@ -0,0 +1,17 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+flake8 = "*"
+
+[packages]
+django = "==2.2.9"
+psycopg2 = "==2.8.4"
+django-decouple = "==2.1"
+social-auth-app-django = "==2.1.0"
+djangorestframework = "==3.10.2"
+
+[requires]
+python_version = "3.6"