diff --git a/.dockerignore b/.dockerignore
new file mode 100644
index 0000000..73752a0
--- /dev/null
+++ b/.dockerignore
@@ -0,0 +1,20 @@
+# General Exclusions
+.git
+.env
+__pycache__
+*.pyc
+.DS_Store
+.vscode
+.idea
+
+# Django Specific Exclusions
+staticfiles/*
+mediafiles/*
+
+# Virtual Environments
+env/
+venv/
+
+# Build and Log Files
+*.log
+node_modules
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..dd84ea7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..bbcbbe7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/main.yml b/.github/main.yml
new file mode 100644
index 0000000..31ae166
--- /dev/null
+++ b/.github/main.yml
@@ -0,0 +1,90 @@
+name: Continuous Integration and Delivery
+
+on: [push]
+
+env:
+ WEB_IMAGE: ghcr.io/$(echo $GITHUB_REPOSITORY | tr '[:upper:]' '[:lower:]')/web
+ NGINX_IMAGE: ghcr.io/$(echo $GITHUB_REPOSITORY | tr '[:upper:]' '[:lower:]')/nginx
+
+jobs:
+
+ build:
+ name: Build Docker Images
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout master
+ uses: actions/checkout@v1
+ - name: Add environment variables to .env
+ run: |
+ echo DEBUG=0 >> .env
+ echo SQL_ENGINE=django.db.backends.postgresql >> .env
+ echo DATABASE=postgres >> .env
+ echo SECRET_KEY=${{ secrets.SECRET_KEY }} >> .env
+ echo SQL_DATABASE=${{ secrets.SQL_DATABASE }} >> .env
+ echo SQL_USER=${{ secrets.SQL_USER }} >> .env
+ echo SQL_PASSWORD=${{ secrets.SQL_PASSWORD }} >> .env
+ echo SQL_HOST=${{ secrets.SQL_HOST }} >> .env
+ echo SQL_PORT=${{ secrets.SQL_PORT }} >> .env
+ - name: Set environment variables
+ run: |
+ echo "WEB_IMAGE=$(echo ${{env.WEB_IMAGE}} )" >> $GITHUB_ENV
+ echo "NGINX_IMAGE=$(echo ${{env.NGINX_IMAGE}} )" >> $GITHUB_ENV
+ - name: Log in to GitHub Packages
+ run: echo ${PERSONAL_ACCESS_TOKEN} | docker login ghcr.io -u ${{ secrets.NAMESPACE }} --password-stdin
+ env:
+ PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+ - name: Pull images
+ run: |
+ docker pull ${{ env.WEB_IMAGE }} || true
+ docker pull ${{ env.NGINX_IMAGE }} || true
+ - name: Build images
+ run: |
+ docker-compose -f docker-compose.ci.yml build
+ - name: Push images
+ run: |
+ docker push ${{ env.WEB_IMAGE }}
+ docker push ${{ env.NGINX_IMAGE }}
+
+ deploy:
+ name: Deploy to DigitalOcean
+ runs-on: ubuntu-latest
+ needs: build
+ steps:
+ - name: Checkout master
+ uses: actions/checkout@v1
+ - name: Add environment variables to .env
+ run: |
+ echo DEBUG=0 >> .env
+ echo SQL_ENGINE=django.db.backends.postgresql >> .env
+ echo DATABASE=postgres >> .env
+ echo SECRET_KEY=${{ secrets.SECRET_KEY }} >> .env
+ echo SQL_DATABASE=${{ secrets.SQL_DATABASE }} >> .env
+ echo SQL_USER=${{ secrets.SQL_USER }} >> .env
+ echo SQL_PASSWORD=${{ secrets.SQL_PASSWORD }} >> .env
+ echo SQL_HOST=${{ secrets.SQL_HOST }} >> .env
+ echo SQL_PORT=${{ secrets.SQL_PORT }} >> .env
+ echo WEB_IMAGE=${{ env.WEB_IMAGE }} >> .env
+ echo NGINX_IMAGE=${{ env.NGINX_IMAGE }} >> .env
+ echo NAMESPACE=${{ secrets.NAMESPACE }} >> .env
+ echo PERSONAL_ACCESS_TOKEN=${{ secrets.PERSONAL_ACCESS_TOKEN }} >> .env
+ - name: Add the private SSH key to the ssh-agent
+ env:
+ SSH_AUTH_SOCK: /tmp/ssh_agent.sock
+ run: |
+ mkdir -p ~/.ssh
+ ssh-agent -a $SSH_AUTH_SOCK > /dev/null
+ ssh-keyscan github.com >> ~/.ssh/known_hosts
+ ssh-add - <<< "${{ secrets.PRIVATE_KEY }}"
+ - name: Build and deploy images on DigitalOcean
+ env:
+ SSH_AUTH_SOCK: /tmp/ssh_agent.sock
+ run: |
+ scp -o StrictHostKeyChecking=no -r ./.env ./docker-compose.prod.yml root@${{ secrets.DIGITAL_OCEAN_IP_ADDRESS }}:/app
+ ssh -o StrictHostKeyChecking=no root@${{ secrets.DIGITAL_OCEAN_IP_ADDRESS }} << 'ENDSSH'
+ cd /app
+ source .env
+ docker login ghcr.io -u $NAMESPACE -p $PERSONAL_ACCESS_TOKEN
+ docker pull $WEB_IMAGE
+ docker pull $NGINX_IMAGE
+ docker-compose -f docker-compose.prod.yml up -d
+ ENDSSH
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6334512
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# This is especially recommended for binary packages to ensure reproducibility, and is more
+# commonly ignored for libraries.
+# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+# pdm.lock
+# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+# in version control.
+# https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+# and can be added to the global gitignore or merged into this file. For a more nuclear
+# option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
\ No newline at end of file
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..06fcb90
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Clearpath Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+ overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+ address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+werefast2000@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..5a2319f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,5 @@
+# Contributing
+
+We welcome contributions to this project! Here's how you can get involved:
+
+* Below are contribution guidelines to follow:
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..c34f504
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ Clearpath
+ Copyright (C) 2024 Clearpath HQ
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ clearpath Copyright (C) 2024 clearpath HQ
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/README.md b/README.md
index acb9012..fdf8af0 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,169 @@
-# Clearpath Backend
+# About CLEARPATH
+ClearPath is a web Project Management tool to help Project Management Professional manage projects and teams of any demand and size respectively.
-This is where you start; install Django, create an .venv and any other necessary requirements
\ No newline at end of file
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Read Me](#read-me)
+* [Installation-MacOs](#installation-macos)
+* [Installation-Windows](#installation-windows)
+* [Continue](#continue)
+* [Commands used-OS X or Linux](#commands-used-os-x-or-linux)
+* [Commands used-Windows](#commands-used-windows)
+* [Libraries](#libraries)
+* [Best Practices](#best-practices)
+* [Git commit message types](#git-commit-message-types)
+* [Streamlining Workflow with Git Flow Branch Naming Conventions](#streamlining-workflow-with-git-flow-branch-naming-conventions)
+* [Contribution](#contribution)
+* [Additional Information (Optional)](#additional-information)
+
+## Installation
+
+Here are the steps to install and run the project:
+
+1. Clone the repository ...
+2. Checkout to "feature" branch
+3. Install dependencies ...
+4. Run the project ...
+
+## Usage
+
+Here's how to use the project functionalities:
+
+* ... (instructions with code snippets or screenshots)
+
+## Read Me
+
+* Read this instructions carefully:
+
+## Installation-MacOS
+
+Always refer to the [Django Installation](https://docs.djangoproject.com/en/5.0/intro/tutorial01/)
+
+1. Clone this repo and navigate to gospives folder
+2. Set Up Virtual Environment: `python3 -m venv venv`
+3. Activate Virtual Environment: `source venv/bin/activate`
+
+## Installation-Windows
+
+1. Clone this repo and navigate to Backend folder
+2. Set Up Virtual Environment: `python -m venv venv`
+3. Activate Virtual Environment: `source venv\Scripts\activate.bat`
+
+## Continue
+
+1. Install all dependecies: `pip install -r requirements.txt`
+2. Create `.env` file in the root folder.
+3. Perform Initial Database Migrations: `python3 manage.py migrate`
+4. (Optional) Create Superuser: `python3 manage.py createsuperuser`
+5. Run Development Server: `python3 manage.py runserver`
+
+## Commands used-OS X or Linux
+
+* `python3 -m venv venv`
+* `source venv/bin/activate`
+* `python -m pip install --upgrade pip`
+* `django-admin startproject clearpath_home .`
+* `python3 manage.py migrate`
+* `python3 manage.py runserver`
+* `python3 manage.py createsuperuser`
+* `python3 manage.py startapp [AppName]`
+* Add these dependencies to your requirements.txt file:`pip freeze > requirements.txt`
+* Protect SECRET_KEYS - `pip install python-dotenv`
+
+## Commands used-Windows
+
+* `python -m venv venv`
+* `source venv\Scripts\activate.bat`
+* `django-admin startproject clearpath_home .`
+* `python manage.py migrate`
+* `python manage.py runserver`
+* `python manage.py createsuperuser`
+* `python manage.py startapp [AppName]`
+* Add these dependencies to your requirements.txt file:`pip freeze > requirements.txt`
+* Protect SECRET_KEYS - `pip install python-dotenv`
+
+## Libraries
+
+1. [Django REST framework](https://www.django-rest-framework.org/)
+2. [django-cors-headers](https://pypi.org/project/django-cors-headers/)
+3. [django-rest-auth](https://django-rest-auth.readthedocs.io/en/latest/installation.html)
+4. [django-allauth](https://docs.allauth.org/en/latest/installation/quickstart.html)
+5. [django-nextjs](https://pypi.org/project/django-nextjs/)
+
+## Best Practices
+
+1. Keep Django Updated: Always stay on the latest version of Django. Regularly update your project to benefit from security fixes and improvements. Major releases occur approximately every 9 months, with minor releases addressing security and bugs almost monthly ()
+
+2. Environment Variables:
+ * Use environment variables to manage settings between local development and production environments. These variables allow you to switch configurations seamlessly.
+ * Consider using packages like `environs` to handle environment variables effectively.
+
+3. DEBUG Mode:
+In your `settings.py`, ensure that the `DEBUG` setting is set to `False` in production. Debug mode provides detailed error pages, which can be a security risk if exposed publicly. Read more on: ()
+
+4. SECRET_KEY:
+ * Keep the `SECRET_KEY` confidential. It’s used for cryptographic signing and should never be shared or exposed.
+ * Generate a strong, random `SECRET_KEY` during project setup.
+ * To Generate a New `SECRET_KEY` in Django, follow the instructions provided on this website: ()
+
+5. Authorization and Authentication:
+ * Implement robust authorization and authentication mechanisms using Gmail, iCloud and other Social Media platforms.
+ * Avoid custom authentication solutions unless necessary.
+
+6. Secure Configurations:
+ * Properly configure the application settings. Guard against common vulnerabilities like cross-site scripting (XSS) and cross-site request forgery (CSRF).
+ * Use HTTPS to encrypt data in transit.
+
+7. Rate Limiting and Brute-Force Protection:
+ * Implement rate limiting to prevent brute-force attacks.
+ * Consider using packages like `django_ratelimit` or `django-axes`.
+
+8. Third-Party Dependencies:
+ * Regularly review and update third-party packages. Vulnerabilities in dependencies can impact the application’s security.
+ * Use tools like `pip-tools` to manage dependencies efficiently.
+
+9. Security Audits:
+ * Perform automated security audits regularly. Tools like `Lynis` can help identify potential issues.
+ * Monitor logs and track suspicious activity.
+
+10. Database Security:
+ * Secure your database connections. Use strong passwords and restrict access.
+ * Avoid using default database credentials.
+
+## Git commit message types
+
+1. *feat:* Introducing new features or significant improvements.
+2. *fix:* Bug fixes that resolve issues in your code.
+3. *docs:* Updates or additions to documentation.
+4. *style:* Cosmetic changes that don't affect code functionality (like formatting).
+5. *refactor:* Code changes that neither fix a bug nor add a feature but improve structure.
+6. *test:* Everything about testing - adding or fixing tests.
+7. *chore:* Routine tasks or updates to the build process.
+8. *perf:* Enhancements that improve performance.
+9. *ci:* Modifications related to CI/CD processes.
+10. *build:* Changes affecting the build system or external dependencies.
+11. *revert:* Undoing previous changes.
+
+## Streamlining Workflow with Git Flow Branch Naming Conventions
+
+*Git Flow* is a branching strategy that helps manage and structure various phases of a project.
+
+1. *master:* The source of truth for production-ready states.
+2. *develop:* The integration branch for development work.
+3. *feature/:* For developing new features, e.g., feature/add-login.
+4. *release/:* Preparing a new production release, e.g., release/1.2.0.
+5. *hotfix/:* Quick fixes for the production version, e.g., hotfix/critical-login-bug.
+6. *support/:* Long-term support for older versions, e.g., support/1.x.
+7. *bugfix/:* For specific bug fixes (optional), e.g., bugfix/login-error.
+
+## Contribution
+
+Please refer to the CONTRIBUTING.md for guidance.
+
+## Additional Information
+
+* website:
+* E-mail:
diff --git a/clearpath_backend/__init__.py b/app/clearpath_home/__init__.py
similarity index 100%
rename from clearpath_backend/__init__.py
rename to app/clearpath_home/__init__.py
diff --git a/clearpath_backend/asgi.py b/app/clearpath_home/asgi.py
similarity index 70%
rename from clearpath_backend/asgi.py
rename to app/clearpath_home/asgi.py
index 93fa32f..8dfe1e6 100644
--- a/clearpath_backend/asgi.py
+++ b/app/clearpath_home/asgi.py
@@ -1,5 +1,5 @@
"""
-ASGI config for clearpath_backend project.
+ASGI config for clearpath_home project.
It exposes the ASGI callable as a module-level variable named ``application``.
@@ -11,6 +11,6 @@
from django.core.asgi import get_asgi_application
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'clearpath_backend.settings')
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'clearpath_home.settings')
application = get_asgi_application()
diff --git a/app/clearpath_home/routers.py b/app/clearpath_home/routers.py
new file mode 100644
index 0000000..2ea0c40
--- /dev/null
+++ b/app/clearpath_home/routers.py
@@ -0,0 +1,3 @@
+from rest_framework import routers
+
+# Register your routers here.
\ No newline at end of file
diff --git a/clearpath_backend/settings.py b/app/clearpath_home/settings.py
similarity index 68%
rename from clearpath_backend/settings.py
rename to app/clearpath_home/settings.py
index b21fc79..851d10e 100644
--- a/clearpath_backend/settings.py
+++ b/app/clearpath_home/settings.py
@@ -1,7 +1,7 @@
"""
-Django settings for clearpath_backend project.
+Django settings for clearpath_home project.
-Generated by 'django-admin startproject' using Django 5.0.1.
+Generated by 'django-admin startproject' using Django 5.0.3.
For more information on this file, see
https://docs.djangoproject.com/en/5.0/topics/settings/
@@ -19,13 +19,24 @@
# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/5.0/howto/deployment/checklist/
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'django-insecure-2)8ktomt*zotyx0o0*)^zdgm0ww^**s)nx#s1&ge@pvk4rmepg'
+import os
+from dotenv import load_dotenv
+
+load_dotenv() # Loads the configs (take environment variables) from .env
+
+# Use the environment variables
+SECRET_KEY = str(os.getenv('SECRET_KEY'))
+SOCIAL_AUTH_GITHUB_KEY = str(os.getenv('GITHUB_KEY'))
+SOCIAL_AUTH_GITHUB_SECRET = str(os.getenv('GITHUB_SECRET'))
+SOCIAL_AUTH_GOOGLE_OAUTH2_KEY = str(os.getenv('GOOGLE_KEY'))
+SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET = str(os.getenv('GOOGLE_SECRET'))
# SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
+DEBUG = bool(os.environ.get("DEBUG", default=0))
-ALLOWED_HOSTS = []
+# 'DJANGO_ALLOWED_HOSTS' should be a single string of hosts with a space between each.
+# For example: 'DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]'
+ALLOWED_HOSTS = os.environ.get("DJANGO_ALLOWED_HOSTS").split(" ")
# Application definition
@@ -49,7 +60,7 @@
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
-ROOT_URLCONF = 'clearpath_backend.urls'
+ROOT_URLCONF = 'clearpath_home.urls'
TEMPLATES = [
{
@@ -67,16 +78,20 @@
},
]
-WSGI_APPLICATION = 'clearpath_backend.wsgi.application'
+WSGI_APPLICATION = 'clearpath_home.wsgi.application'
# Database
# https://docs.djangoproject.com/en/5.0/ref/settings/#databases
DATABASES = {
- 'default': {
- 'ENGINE': 'django.db.backends.sqlite3',
- 'NAME': BASE_DIR / 'db.sqlite3',
+ "default": {
+ "ENGINE": os.environ.get("SQL_ENGINE", "django.db.backends.sqlite3"),
+ "NAME": os.environ.get("SQL_DATABASE", BASE_DIR / "db.sqlite3"),
+ "USER": os.environ.get("SQL_USER", "user"),
+ "PASSWORD": os.environ.get("SQL_PASSWORD", "password"),
+ "HOST": os.environ.get("SQL_HOST", "localhost"),
+ "PORT": os.environ.get("SQL_PORT", "5432"),
}
}
diff --git a/clearpath_backend/urls.py b/app/clearpath_home/urls.py
similarity index 93%
rename from clearpath_backend/urls.py
rename to app/clearpath_home/urls.py
index dfcbdbb..2ceef0e 100644
--- a/clearpath_backend/urls.py
+++ b/app/clearpath_home/urls.py
@@ -1,5 +1,5 @@
"""
-URL configuration for clearpath_backend project.
+URL configuration for clearpath_home project.
The `urlpatterns` list routes URLs to views. For more information please see:
https://docs.djangoproject.com/en/5.0/topics/http/urls/
diff --git a/clearpath_backend/wsgi.py b/app/clearpath_home/wsgi.py
similarity index 70%
rename from clearpath_backend/wsgi.py
rename to app/clearpath_home/wsgi.py
index e2de782..0469cd9 100644
--- a/clearpath_backend/wsgi.py
+++ b/app/clearpath_home/wsgi.py
@@ -1,5 +1,5 @@
"""
-WSGI config for clearpath_backend project.
+WSGI config for clearpath_home project.
It exposes the WSGI callable as a module-level variable named ``application``.
@@ -11,6 +11,6 @@
from django.core.wsgi import get_wsgi_application
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'clearpath_backend.settings')
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'clearpath_home.settings')
application = get_wsgi_application()
diff --git a/app/compose/local/django/Dockerfile b/app/compose/local/django/Dockerfile
new file mode 100644
index 0000000..c755e68
--- /dev/null
+++ b/app/compose/local/django/Dockerfile
@@ -0,0 +1,40 @@
+# pull official base image
+FROM python:3.11.4-slim-buster
+
+# set work directory
+WORKDIR /usr/src/app
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# install system dependencies
+RUN apt-get update && apt-get install -y netcat
+
+RUN apt-get update \
+ && apt-get install -y \
+ build-essential \
+ libpq-dev \
+ python3-dev \
+ netcat \
+ && pip install psycopg2
+
+# install dependencies
+RUN pip install --upgrade pip
+
+COPY ./app/requirements.txt /requirements.txt
+RUN pip install -r /requirements.txt
+
+COPY ./app/compose/local/django/entrypoint /entrypoint
+RUN sed -i 's/\r$//g' /entrypoint
+RUN chmod +x /entrypoint
+
+COPY ./app/compose/local/django/start /start
+RUN sed -i 's/\r$//g' /start
+RUN chmod +x /start
+
+# copy project
+COPY . .
+
+# run entrypoint.sh
+ENTRYPOINT ["/usr/src/app/compose/local/django/entrypoint"]
diff --git a/app/compose/local/django/entrypoint b/app/compose/local/django/entrypoint
new file mode 100755
index 0000000..a80487f
--- /dev/null
+++ b/app/compose/local/django/entrypoint
@@ -0,0 +1,17 @@
+#!/bin/sh
+
+if [ "$DATABASE" = "postgres" ]
+then
+ echo "Waiting for postgres..."
+
+ while ! python -c "import socket; s = socket.socket(socket.AF_INET, socket.SOCK_STREAM); s.connect(('$SQL_HOST', $SQL_PORT)); s.close()"; do
+ sleep 0.1
+ done
+
+ echo "PostgreSQL started"
+fi
+
+python manage.py flush --no-input
+python manage.py migrate
+
+exec "$@"
\ No newline at end of file
diff --git a/app/compose/local/django/start b/app/compose/local/django/start
new file mode 100644
index 0000000..e7a2d5c
--- /dev/null
+++ b/app/compose/local/django/start
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+# python manage.py migrate
+python manage.py runserver 0.0.0.0:8000
\ No newline at end of file
diff --git a/app/compose/production/django/Dockerfile.prod b/app/compose/production/django/Dockerfile.prod
new file mode 100644
index 0000000..79f0057
--- /dev/null
+++ b/app/compose/production/django/Dockerfile.prod
@@ -0,0 +1,40 @@
+# pull official base image
+FROM python:3.11.4-slim-buster
+
+# set work directory
+WORKDIR /usr/src/app
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# install system dependencies
+RUN apt-get update && apt-get install -y netcat
+
+RUN apt-get update \
+ && apt-get install -y \
+ build-essential \
+ libpq-dev \
+ python3-dev \
+ netcat \
+ && pip install psycopg2
+
+# install dependencies
+RUN pip install --upgrade pip
+
+COPY ./app/requirements.txt /requirements.txt
+RUN pip install -r /requirements.txt
+
+COPY ./app/compose/local/django/entrypoint /entrypoint
+RUN sed -i 's/\r$//g' /entrypoint
+RUN chmod +x /entrypoint
+
+COPY ./app/compose/local/django/start /start
+RUN sed -i 's/\r$//g' /start
+RUN chmod +x /start
+
+# copy project
+COPY . .
+
+# run entrypoint.sh
+ENTRYPOINT ["/usr/src/app/entrypoint.prod.sh"]
\ No newline at end of file
diff --git a/app/compose/production/django/entrypoint b/app/compose/production/django/entrypoint
new file mode 100755
index 0000000..9ec9164
--- /dev/null
+++ b/app/compose/production/django/entrypoint
@@ -0,0 +1,42 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+set -x
+
+
+log() {
+ local level="$1"
+ local message="$2"
+ echo "{\"level\": \"${level}\", \"message\": \"${message}\"}"
+}
+
+
+postgres_ready() {
+python3 << END
+import sys
+
+import psycopg2
+
+try:
+ psycopg2.connect(
+ dbname="${SQL_DATABASE}",
+ user="${SQL_USER}",
+ password="${SQL_PASSWORD}",
+ host="${SQL_HOST}",
+ port="${SQL_PORT}",
+ )
+except psycopg2.OperationalError:
+ sys.exit(-1)
+sys.exit(0)
+
+END
+}
+until postgres_ready; do
+ >&2 echo 'Waiting for PostgreSQL to become available...'
+ sleep 1
+done
+>&2 echo 'PostgreSQL is available'
+
+exec "$@"
\ No newline at end of file
diff --git a/app/compose/production/django/start b/app/compose/production/django/start
new file mode 100644
index 0000000..9777109
--- /dev/null
+++ b/app/compose/production/django/start
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+python3 /app/manage.py collectstatic --noinput
+python3 /app/manage.py migrate
+
+/usr/local/bin/gunicorn clearpath_home.asgi:application -k uvicorn.workers.UvicornWorker --bind 0.0.0.0:8000 --chdir=/app
\ No newline at end of file
diff --git a/app/compose/production/entrypoint.prod b/app/compose/production/entrypoint.prod
new file mode 100644
index 0000000..bd7f967
--- /dev/null
+++ b/app/compose/production/entrypoint.prod
@@ -0,0 +1,13 @@
+#!/bin/sh
+if [ "$DATABASE" = "postgres" ]
+then
+ echo "Waiting for postgres..."
+
+ while ! python -c "import socket; s = socket.socket(socket.AF_INET, socket.SOCK_STREAM); s.connect(('$SQL_HOST', $SQL_PORT)); s.close()"; do
+ sleep 0.1
+ done
+
+ echo "PostgreSQL started"
+fi
+
+exec "$@"
\ No newline at end of file
diff --git a/app/compose/production/nginx/Dockerfile b/app/compose/production/nginx/Dockerfile
new file mode 100644
index 0000000..0a8ac65
--- /dev/null
+++ b/app/compose/production/nginx/Dockerfile
@@ -0,0 +1,4 @@
+FROM nginx:1.25.3-alpine
+
+RUN rm /etc/nginx/conf.d/default.conf
+COPY nginx.conf /etc/nginx/conf.d
\ No newline at end of file
diff --git a/app/compose/production/nginx/nginx.conf b/app/compose/production/nginx/nginx.conf
new file mode 100644
index 0000000..27be41f
--- /dev/null
+++ b/app/compose/production/nginx/nginx.conf
@@ -0,0 +1,29 @@
+upstream clearpath {
+ server web:8000;
+}
+
+server {
+ listen 80;
+ location / {
+ proxy_pass http://clearpath;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header Host $host;
+ proxy_redirect off;
+ client_max_body_size 20M;
+ }
+ location /static/ {
+ alias /app/staticfiles/;
+ }
+ location /media/ {
+ alias /app/mediafiles/;
+ }
+
+ location /ws {
+ proxy_pass http://clearpath;
+ proxy_http_version 1.1;
+ proxy_set_header Upgrade $http_upgrade;
+ proxy_set_header Connection "upgrade";
+ proxy_set_header Host $http_host;
+ proxy_set_header X-Real-IP $remote_addr;
+ }
+}
diff --git a/manage.py b/app/manage.py
similarity index 87%
rename from manage.py
rename to app/manage.py
index a6fc3b2..fc79a50 100644
--- a/manage.py
+++ b/app/manage.py
@@ -6,7 +6,7 @@
def main():
"""Run administrative tasks."""
- os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'clearpath_backend.settings')
+ os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'clearpath_home.settings')
try:
from django.core.management import execute_from_command_line
except ImportError as exc:
diff --git a/app/requirements.txt b/app/requirements.txt
new file mode 100644
index 0000000..e614dd5
--- /dev/null
+++ b/app/requirements.txt
@@ -0,0 +1,11 @@
+django==5.0.3
+pillow==10.3.0
+djangorestframework
+djangorestframework-simplejwt
+pyyaml
+requests
+django-cors-headers
+python-dotenv
+django-filter
+django-nextjs
+markdown
\ No newline at end of file
diff --git a/app/users/__init__.py b/app/users/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/app/users/admin.py b/app/users/admin.py
new file mode 100644
index 0000000..8c38f3f
--- /dev/null
+++ b/app/users/admin.py
@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.
diff --git a/app/users/apps.py b/app/users/apps.py
new file mode 100644
index 0000000..72b1401
--- /dev/null
+++ b/app/users/apps.py
@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class UsersConfig(AppConfig):
+ default_auto_field = 'django.db.models.BigAutoField'
+ name = 'users'
diff --git a/app/users/migrations/__init__.py b/app/users/migrations/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/app/users/models.py b/app/users/models.py
new file mode 100644
index 0000000..71a8362
--- /dev/null
+++ b/app/users/models.py
@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.
diff --git a/app/users/tests.py b/app/users/tests.py
new file mode 100644
index 0000000..7ce503c
--- /dev/null
+++ b/app/users/tests.py
@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.
diff --git a/app/users/views.py b/app/users/views.py
new file mode 100644
index 0000000..91ea44a
--- /dev/null
+++ b/app/users/views.py
@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.
diff --git a/docker-compose.ci.yml b/docker-compose.ci.yml
new file mode 100644
index 0000000..39f52f0
--- /dev/null
+++ b/docker-compose.ci.yml
@@ -0,0 +1,46 @@
+version: "3.9"
+
+services:
+ web:
+ build:
+ context: ./app
+ dockerfile: ./compose/production/django/Dockerfile
+ cache_from:
+ - "${WEB_IMAGE}"
+ image: "${WEB_IMAGE}"
+ command: gunicorn hello_django.wsgi:application --bind 0.0.0.0:8000
+ volumes:
+ - static_volume:/app/staticfiles
+ - media_volume:/app/mediafiles
+ expose:
+ - 8000
+ env_file: .env
+
+
+ nginx:
+ build:
+ context: ./nginx
+ cache_from:
+ - "${NGINX_IMAGE}"
+ image: "${NGINX_IMAGE}"
+ volumes:
+ - static_volume:/app/staticfiles
+ - media_volume:/app/mediafiles
+ ports:
+ - 80:80
+ depends_on:
+ - web
+
+
+ db:
+ image: postgres:16-alpine
+ volumes:
+ - postgres_data:/var/lib/postgresql/data/
+ environment:
+ POSTGRES_USER: clearpath
+ POSTGRES_PASSWORD: clearpath
+ POSTGRES_DB: clearpath_dev
+
+volumes:
+ static_volume:
+ media_volume:
\ No newline at end of file
diff --git a/docker-compose.prod.yml b/docker-compose.prod.yml
new file mode 100644
index 0000000..26de45b
--- /dev/null
+++ b/docker-compose.prod.yml
@@ -0,0 +1,25 @@
+version: "3.8"
+
+services:
+ web:
+ image: "${WEB_IMAGE}"
+ command: gunicorn clearpath_home.wsgi:application --bind 0.0.0.0:8000
+ volumes:
+ - static_volume:/usr/src/app/staticfiles
+ - media_volume:/usr/src/app/mediafiles
+ ports:
+ - 8000:8000
+ env_file: .env
+ nginx:
+ image: "${NGINX_IMAGE}"
+ volumes:
+ - static_volume:/usr/src/app/staticfiles
+ - media_volume:/usr/src/app/mediafiles
+ ports:
+ - 80:80
+ depends_on:
+ - web
+
+volumes:
+ static_volume:
+ media_volume:
\ No newline at end of file
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 0000000..3e537ca
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,30 @@
+version: '3.8'
+
+services:
+ web:
+ build:
+ context: .
+ dockerfile: ./app/compose/local/django/Dockerfile
+ image: clearpath
+ command: /start
+ volumes:
+ - ./app/:/usr/src/app/
+ ports:
+ - 8000:8000
+ env_file:
+ - ./.env/.env.dev
+ depends_on:
+ - db
+ db:
+ image: postgres:15
+ volumes:
+ - postgres_data:/var/lib/postgresql/data/
+ environment:
+ POSTGRES_USER: clearpath
+ POSTGRES_PASSWORD: clearpath
+ POSTGRES_DB: clearpath_dev
+ ports:
+ - "5432:5432"
+
+volumes:
+ postgres_data:
diff --git a/nginx/Dockerfile b/nginx/Dockerfile
new file mode 100644
index 0000000..29ffd3c
--- /dev/null
+++ b/nginx/Dockerfile
@@ -0,0 +1,4 @@
+FROM nginx:1.21-alpine
+
+RUN rm /etc/nginx/conf.d/default.conf
+COPY nginx.conf /etc/nginx/conf.d
\ No newline at end of file
diff --git a/nginx/nginx.conf b/nginx/nginx.conf
new file mode 100644
index 0000000..972a4cd
--- /dev/null
+++ b/nginx/nginx.conf
@@ -0,0 +1,24 @@
+upstream clearpath {
+ server web:8000;
+}
+
+server {
+
+ listen 80;
+
+ location / {
+ proxy_pass http://clearpath;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header Host $host;
+ proxy_redirect off;
+ }
+
+ location /staticfiles/ {
+ alias /usr/src/app/staticfiles/;
+ }
+
+ location /mediafiles/ {
+ alias /usr/src/app/mediafiles/;
+ }
+
+}
\ No newline at end of file