Authentication

.env-example

@@ -0,0 +1,25 @@
+DEBUG=True
+
+DJANGO_SECRET_KEY=aaaaa
+
+PUBLIC_KEY=
+
+API_KEY=
+
+
+# Credentials for database
+
+DB_NAME=aaa
+DB_USER=aaa
+DB_HOST=localhost
+DB_PASSWORD=aaaa
+DB_PORT=5432
+
+#Email Credentials
+
+EMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend
+EMAIL_HOST=aaaa
+EMAIL_HOST_USER=aaaa
+EMAIL_PORT=465
+EMAIL_USE_SSL=True
+EMAIL_HOST_PASSWORD=aaaa

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+name: "CodeQL"
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: '0 3 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Override automatic language detection by changing the below list
+        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
+        language: ['python', 'javascript']
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file. 
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# How to contribute to Django SAAS
+
+## Set up working copy of repo in your computer
+
+Firstly, you need a local copy of the project. Press the "fork" button in Github to create a copy of the repository in your own Github account.
+
+Now go ahead and create a local copy, find the "SSH clone URL" in the right hand column and use that to clone locally using the terminal:
+
+```
+git clone https://github.com/<your-username>/django_saas.git
+```
+
+After cloning the repository, now change into the new project's directory:
+
+```
+cd django_saas
+```
+
+Set up a new remote that points to the original project so that you can grab any changes and bring them into your local copy.
+
+```
+git remote add upstream https://github.com/devmedtz/django_saas.git
+```
+
+Now you have two remotes for this project:
+
+- _origin_ which points to your Github fork of the project. You can read and write to this remote.
+- _upstream_ which point to the main project's Github repository. You can only read from this remote.
+
+
+## Get it working on your computer
+
+Now you have the source code, get it working on your computer by following instruction on [README file](README.md).
+
+
+## Do some work
+
+Pick up an issue, reproduce it on your version. Once you have reproduced it, read the code to work out where the problem is. Once you've found the code problem, you can move on to fixing it.
+
+If it's addition of feature, go on write the code for the particular feature.
+
+> **For each issue/feature you are working on make sure to create a branch for it.**
+
+First, make sure you are in a ```main``` branch
+
+```
+git checkout main
+```
+Sync your local copy with the upstream project
+
+```
+git pull upstream main
+```
+Then sync it to your forked Github project
+
+```
+git push origin main
+```
+
+Now you can create a branch on which you will work on.
+
+```
+git checkout -b <branch-name>
+```
+
+> **Ensure that you only fix the thing you're working on. Do not be tempted to fix some other things that you see along the way, including formatting issues, as your Pull Request (PR) will probably be rejected.**
+
+Make sure you commit in logical blocks. Each commit message should be sane. Check this [commit messages guide](https://gist.github.com/brianclements/841ea7bffdb01346392c).
+
+# Create the Pull Request (PR)
+
+Create a PR by pushing your branch to the _origin_ remote and then press some buttons on Github.
+
+To push new branch:
+```
+git push -u origin <branch-name>
+```
+
+This will create the branch on your Github project.
+
+Swap back to the browser and navigate to your fork of the project `https://github.com/<username>/django_saas.git` and you'll see that your new branch is listed at the top with a handy "Compate & pull request button". Get ahead and press the button.
+
+Ensure you provide a good, succint title for your pull request and explain why you have created in the in the description box. Add any relevant issue numbers if you have them.
+
+> Don't forget to add your name in [Contributors List](AUTHORS.md)
+
+# Review by the maintainers
+
+For your work to be integrated into the project, the maintainer will review your work and either request changes or merge it.
+
+# What next?
+
+Once your PR has been merged, you can delete your branch. Firstly update your main with the changes from maintainers:
+
+```
+git checkout main
+git pull upstream main
+git push origin main
+```
+
+You can now delete your branch:
+
+```
+git branch -d <branch-name>
+git push origin --delete <branch-name>
+```
+
+You now have a latest version of the code, so for your next change you can start again at creating new branch.
+
+```
+git checkout main
+git pull upstream main
+git push origin main
+git checkout -b <new-branch-name>
+```
+and away you go making the changes required.
+
+# Attribution
+
+This guide is adopted from [Rob Allen article](https://akrabat.com/the-beginners-guide-to-contributing-to-a-GitHub-project)

README.md

@@ -9,19 +9,39 @@ django-saas is a generic subscription billing system built for django projects.
 5. Payment gateway should be MPESA, by mpesa open api
 
 ## Installation
-1. clone the repo
-
-   git clone git@github.com:devmedtz/django_saas.git
+- Clone the repo
 
-2. Install the virtual env and activate
+   ```git clone git@github.com:devmedtz/django_saas.git```
 
-3. Install the requirements packages
-
-   pip install -r requirements.txt
+- Create virtual environment and activate it.
 
-4. create your feature branch eg. payment gateway branch
+   ```
+   virtualenv env
 
-5. Start contribution then push on your branch
+   env/scripts/activate
+   ```
 
+- Install the required packages
 
-------your welcome for Contribution --------
+   ```pip install -r requirements.txt```
+
+-  Create and apply migrations
+
+   ```python manage.py makemigrations```
+
+   ```python manage.py migrate```
+
+- rename ```.env-sample``` to ```.env``` and fill accordingly.
+
+- Create superuser
+
+   ```python manage.py createsuperuser```
+
+- Run development server
+
+   ```python manage.py runserver```
+
+
+### Contributions are warmly welcomed.
+
+- Start contributing following the [contributing guide](CONTRIBUTING.md)

SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

accounts/admin.py

@@ -1,3 +1,6 @@
 from django.contrib import admin
+from .models import CustomUser, Profile
 
 # Register your models here.
+admin.site.register(CustomUser)
+admin.site.register(Profile)

accounts/forms.py

@@ -1,17 +1,20 @@
 from django import forms
-from .models import CustomUser
+
 from django.contrib.auth import get_user_model
 
 User = get_user_model()
 
+# todo: #26 add forms for adding and updating user
+
 
 class SignUpForm(forms.ModelForm):
     password1 = forms.CharField(label='Password', widget=forms.PasswordInput)
-    password2 = forms.CharField(label='Password confirmation', widget=forms.PasswordInput)
+    password2 = forms.CharField(
+        label='Password confirmation', widget=forms.PasswordInput)
 
-    class Meta: 
+    class Meta:
         model = User
-        fields = ['name','email','phone']
+        fields = ['name', 'email', 'phone']
 
     def clean_password2(self):
         password1 = self.cleaned_data.get("password1")
@@ -34,10 +37,11 @@ class CreateStaffForm(forms.ModelForm):
 
     class Meta:
         model = User
-        fields = ['name','email','phone','is_active']
+        fields = ['name', 'email', 'phone', 'is_active']
+
 
 class UpdateStaffForm(forms.ModelForm):
 
     class Meta:
         model = User
-        fields = ['name','email','phone','is_active']
+        fields = ['name', 'email', 'phone', 'is_active']

accounts/managers.py

@@ -1,4 +1,3 @@
-from django.db import models
 from django.contrib.auth.models import BaseUserManager
 
 
@@ -27,4 +26,4 @@ def create_superuser(self, email, name, phone, password=None):
         user.is_active = True
         user.is_superuser = True
         user.save(using=self._db)
-        return user
+        return user

accounts/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 3.0.7 on 2020-10-13 07:44
+# Generated by Django 3.0.7 on 2020-10-13 14:01
 
 import accounts.models
 from django.conf import settings
@@ -25,7 +25,7 @@ class Migration(migrations.Migration):
                 ('phone', models.CharField(max_length=50, unique=True, verbose_name='Phone Number')),
                 ('is_superuser', models.BooleanField(default=False)),
                 ('is_admin', models.BooleanField(default=False)),
-                ('is_manager', models.BooleanField(default=True)),
+                ('is_manager', models.BooleanField(default=False)),
                 ('is_staff', models.BooleanField(default=False)),
                 ('is_active', models.BooleanField(default=False)),
                 ('created_by', models.CharField(blank=True, max_length=100, null=True)),

accounts/migrations/0002_auto_20201013_1725.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.7 on 2020-10-13 14:25
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('accounts', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='customuser',
+            old_name='is_staff',
+            new_name='is_team',
+        ),
+    ]