diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..34c6d423 --- /dev/null +++ b/404.html @@ -0,0 +1,599 @@ + + + + + + + + + + + + + + + + + + People Depot Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/CONTRIBUTING/index.html b/CONTRIBUTING/index.html new file mode 100644 index 00000000..ac47bc65 --- /dev/null +++ b/CONTRIBUTING/index.html @@ -0,0 +1,1430 @@ + + + + + + + + + + + + + + + + + + + + + + Contributing - People Depot Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+ + + + + + + + + + + + +

Contributing

+

Thank you for volunteering your time! The following is a set of guidelines for contributing to the peopledepot repository, which is hosted on GitHub.

+

Please make sure you have completed the onboarding process which includes joining the Hack for LA Slack, GitHub, and Google Drive. If you have not been onboarded, see the Getting Started Page. Workshop attendees are granted a temporary exception from this requirement.

+

1. Joining Repository Team

+

This step is optional if this is your first time fixing an issue and you want to try fixing an issue without this step.

+

In the hfla-site Slack channel, send an introductory message with your GitHub handle/username asking to be added to the Hack for LA peopledepot GitHub repository, have access to the Google Docs Drive, and Figma.

+

NOTE: Once you have accepted the GitHub invite (comes via email or in your GitHub notifications), please do the following:

+

Make your own Hack for LA GitHub organization membership public by following this guide.

+

2. Setting Up Development Environment

+

2.1 Pre-requisites

+

2.1.1 GitHub account

+

See here for creating a GitHub account. If you are not familiar with Git, this tutorial is recommended.

+

2.1.2 Two-factor authentication

+

Set up two-factor authentication on your account by following this guide.

+

2.1.3 Text editor

+

VS Code is recommended, but feel free to use a text editor of your choice.

+

2.1.4 Install Git

+

Before cloning your forked repository to your local machine, you must have Git installed. You can find instructions for installing Git for your operating system here.

+

Installation Guide for Windows Users +- we recommend installing Windows Subsystem for Linux (WSL). WSL provides a Linux-compatible environment that can prevent common errors during script execution. +- After setting up WSL, install Git directly from the Linux terminal. This method can help avoid complications that sometimes arise when using Git Bash on Windows. +- If you prefer Git Bash or encounter errors related to line endings when running scripts, the problem might be due to file conversions in Windows. To address this, configure Git as follows: +

    git config --system set autocrlf=false
+
+Feel free to reach out in the Hack for LA Slack channel if you encounter any errors while running scripts on Windows.

+

Please note that if you have a Mac the page offers several options (see other option, if you need to conserve hard drive space) including:

+
    +
  • an “easiest” option (this version is fine for use at hackforla): This option would take just over 4GB.
    • +
  • a “more up to date” option (not required but optional if you want it): This option prompts you to go to install an 8GB package manager called Homebrew.
    • +
  • Other option: If your computer is low on space, you can use this tutorial to install XCode Command Tools and a lighter version of Homebrew and then install Git using this command: $ brew install git which in total only uses 300MB.
    • +
+

2.1.5 Install Docker

+

Install or make sure docker and docker-compose are installed on your computer

+
    docker -v
+    docker-compose -v
+
+

The recommended installation method for your operating system can be found here. Feel free to reach out in the Hack for LA Slack channel if you have trouble installing docker on your system

+

More on using Docker and the concepts of containerization:

+ +

2.2 Fork the repository

+

You can fork the hackforla/peopledepot repository by clicking +. A fork is a copy of the repository that will be placed on your GitHub account.

+

Note: It should create a URL that looks like the following -> https://github.com/<your_GitHub_user_name>/peopledepot.

+

For example -> https://github.com/octocat/peopledepot.

+

Be Aware: What you have created is a forked copy in a remote version on GitHub. It is not yet on your local machine yet.

+

2.2.1 Clone a copy on your computer

+

The following steps will clone (create) a local copy of the forked repository on your computer.

+
    +
  1. Create a new folder in your computer that will contain hackforla projects.
    2. +
+

In your command line interface (Terminal, Git Bash, Powershell), move to where you want your new folder to be placed and create a new folder in your computer that will contain hackforla projects. After that, navigate into the folder(directory) you just created.

+

For example:

+
cd /projects
+mkdir hackforla
+cd hackforla
+
+
    +
  1. From the hackforla directory created in previous section:
    2. +
+
git clone https://github.com/<your_GitHub_user_name>/peopledepot.git
+
+

For example if your GitHub username was octocat:

+
git clone https://github.com/octocat/peopledepot.git
+
+

**Note: You can also clone using ssh which is more secure but requires more setup. Because of the additional setup, cloning using https as shown above is recommended.

+

You should now have a new folder in your hackforla folder called peopledepot. Verify this by changing into the new directory:

+
cd peopledepot
+
+

2.2.2 Verify and set up remote references

+

Verify that your local cloned repository is pointing to the correct origin URL (that is, the forked repo on your own GitHub account):

+
git remote -v
+
+

You should see fetch and push URLs with links to your forked repository under your account (i.e. https://github.com/<your_GitHub_user_name>/peopledepot.git). You are all set to make working changes to the website on your local machine.

+

However, we still need a way to keep our local repo up to date with the deployed website. To do so, you must add an upstream remote to incorporate changes made while you are working on your local repo. Run the following to add an upstream remote URL & update your local repo with recent changes to the hackforla version:

+
git remote add upstream https://github.com/hackforla/peopledepot.git
+git fetch upstream
+
+

After adding the upstream remote, you should now see it if you again run git remote -v :

+
origin  https://github.com/<your_GitHub_user_name>/peopledepot.git (fetch)
+origin  https://github.com/<your_GitHub_user_name>/peopledepot.git (push)
+upstream        https://github.com/hackforla/peopledepot.git (fetch)
+upstream        https://github.com/hackforla/peopledepot.git (push)
+
+

2.3 Build and run using Docker locally

+
    +
  1. Start Docker Desktop
    2. +
  2. Run docker container ls to verify Docker Desktop is running. If it is not running you will get the message: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
    3. +
  3. Create an .env.dev file from .env.dev-sample
    4. +
+
cp .env.dev-sample .env.dev
+
+
    +
  1. Build and run the project via the script (this includes running docker-compose up)
    2. +
+
./scripts/buildrun.sh
+
+
    +
  1. Create a super user for logging into the web admin interface
    2. +
+
docker-compose exec web python manage.py createsuperuser --no-input
+
+
    +
  1. Browse to the web admin interface at http://localhost:8000/admin/ and confirm the admin site is running. Use DJANGO_SUPERUSER_USERNAME and DJANGO_SUPERUSER_PASSWORD from .env.dev for credentials.
    2. +
+

3. Managing Docker

+

3.1 Stopping Docker

+

To stop the service-container, but not destroy it (often sufficient for day-to-day work):

+
docker-compose stop
+
+

To stop and destroy the service container:

+
docker-compose down
+
+

Add the -v flag to destroy the data volumes as well:

+
docker-compose down -v
+
+

3.2 Recycling / Refreshing Database

+

To restore a database to its original state and remove any data manually added, delete the container and image. +From Docker:

+
    +
  1. Open Containers section
    2. +
  2. Delete people-db-1 container
    3. +
  3. Open Images Tab
    4. +
  4. Remove djangorestapipostrgresql image
    5. +
+

4. Fixing Issues

+

4.1 Find an issue

+

Find an issue in Prioritized Backlog here

+

If you joined the peopledepot repository as described in a previous section:

+
    +
  1. Assign the issue to yourself and move it to "In progress" column.
    2. +
  2. Follow the steps in the issue description to complete the issue.
    3. +
  3. Make sure to comment your ETA and Availability when you first assign yourself.
    4. +
+

If you don't have privileges, add a comment that you are working on the issue.

+

4.2 Create a new branch

+

Once you have selected an issue to work on, create a branch for that issue.

+

Verify you are on the main branch.

+
git branch
+
+

You will see a list of all of your branches. There will be a star (*) next to the branch that you are currently in. By default you should start on the main branch.

+

If you are not currently in the main branch, run the following command to return to it:

+
git checkout main
+
+
git pull origin main
+
+

This ensures you have the most recent code, which is important if you previously cloned and it has been more than a day.

+

Create a new branch where you will work on the issue. The branch name should include the issue number. For example, to create a new branch for issue 15 and change into it:

+
git checkout -b <new-branch-name>-15
+
+

4.3 Make changes

+

Make changes to fix the issue.

+

4.4 Pull to get the most recent code

+

You can probably skip this if you fix the issue on the same day that you pulled the code.

+
git pull
+
+

Note: If you are using Visual studios code you can use the Git graphical user interface to stage your changes. For instructions check out the Git Gui Wiki.

+

4.5 Add changed files to staging

+

Make sure you are on your issue branch (instead of main)

+
git branch
+
+

You must add your files to the staging area before you can commit (save them to git).

+

Run this command if you want to add changes from a specific file to your commit record:

+
git add “filename.ext”
+
+

Run this command if you want to add all changes to all file(s) to your commit record:

+
git add .
+
+

4.6 Check Git status

+

This command will list the files that have been staged with green text. These are the files that will be committed (saved) when you run the next command, git commit. Please be sure all your staged changes are relevant to the issue you are working on. If you accidentally included unrelated changes, please unstage them before making this commit, and then make a new commit for the unrelated changes. (The commands for unstaging commits are provided in the output of your git status command.)

+
git status
+
+

4.7 Remove files that you don't want staged

+

This command will unstage a file that you don't want included in the commit. The specified file will not be committed (saved) when you run the next command, git commit. This only works if the wrong files were added, but they were not yet committed. (See this tutorial for an in-depth discussion.) The file will be removed from the staging area, but not actually deleted:

+
git reset HEAD “filename.ext”
+
+

4.8 Run pre-commit checks

+

Important: before committing each file, make sure to run the pre-commit script:*

+
./scripts/precommit-check.sh
+
+

4.9 Commit staged changes

+

This command saves your work, and prepares it to push to your repository. Use the -m flag to quickly add a message to your commit. Your message should be a short description of the changes you made. It will be extremely helpful if other people can understand your message, so try to resist the temptation to be overly cryptic.

+

To commit your changes with a message, run:

+
git commit -m “insert message here”
+
+

Ensure that your local repository is up-to-date with the main site:

+
git pull upstream
+
+

You can also sync your fork directly on GitHub by clicking "Sync Fork" at the right of the screen and then clicking "Update Branch"

+
+ Click here to see how to sync the fork on GitHub + +
+ +

4.10 Push to upstream origin (aka, your fork)

+

Push your local branch to your remote repository:

+
git push --set-upstream origin <your-branch-name>
+
+

Alternatively, you can run

+
git push
+
+

4.11 Create a pull request

+

4.11.1 Push all changes in your issue branch

+

Once you are satisfied with your changes, push them to the feature branch you made within your remote repository.

+
git push --set-upstream origin <name-of-branch>
+
+

4.11.2 Complete pull request from GitHub

+
    +
  1. Click the green button to create a Pull Request (PR)
    2. +
  2. Add a short title in the subject line
    3. +
  3. In the body of the comment, add the following, replacing <issue-number> with the issue you worked on:
    4. +
+
fixes #<issue-number>
+
+
    +
  1. Below this, add a brief description of the changes you made
    2. +
  2. Click the green "Create pull request" button
    3. +
  3. Add the PR to the project board
    4. +
+

5. Synch Main Changes

+

Your fork of this repository on GitHub, and your local clone of that fork, will get out of sync with the (upstream) repository as others update the repository. (That's what has happened when you see something like "This branch is 1 commit behind peopledepot:main" on your forked repository.)

+

One way to keep your fork up to date with this repository is to follow these instruction: Syncing your fork to the original repository via the browser

+

You can also update your fork via the local clone of your fork, using these instructions. Assuming you have a local clone with remotes upstream (this repo) and origin (your GitHub fork of this repo):

+
    +
  • First, you will need to create a local branch which tracks upstream/main. You will only need to do this once; you do not need to do this every time you want to incorporate upstream changes.
    • +
+

Run the following two commands:

+
git fetch upstream
+git checkout -b upstream-main --track upstream/main
+
+

If you have already created the branch upstream-main, the following commands will incorporate upstream changes:

+
git checkout upstream-main # Move to the branch you want to merge with.
+git pull  # This updates your tracking branch to match the main branch in this repository
+git checkout main  # Move back to your main branch
+git merge upstream-main  # Merge to bring your main current.
+
+

If you do all your work on topic branches (as suggested above) and keep main free of local modifications, this merge should apply cleanly.

+

Then push the merge changes to your GitHub fork:

+
git push
+
+

If you go to your online GitHub repository this should remove the message "This branch is x commit behind peopledepot:main".

+

5. Creating Issues

+

To create a new issue, please use the blank issue template (available when you click New Issue). If you want to create an issue for other projects to use, please create the issue in your own repository and send a slack message to one of your hack night hosts with the link.

+

Appendix

+

A. Submitting Bugs for Third Party Packages / Apps

+

You can go to these links and submit an issue:

+ + + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/LICENSE/index.html b/LICENSE/index.html new file mode 100644 index 00000000..6b079152 --- /dev/null +++ b/LICENSE/index.html @@ -0,0 +1,954 @@ + + + + + + + + + + + + + + + + + + + + LICENSE - People Depot Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+ + + + + + + + + + + + +

LICENSE

+ +
                GNU GENERAL PUBLIC LICENSE
+                   Version 2, June 1991
+
+

Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed.

+
                        Preamble
+
+

The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it.

+

For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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.

+

We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software.

+

Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations.

+

Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all.

+

The precise terms and conditions for copying, distribution and +modification follow.

+
                GNU GENERAL PUBLIC LICENSE
+
+

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

+
    +
  1. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you".
    2. +
+

Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does.

+
    +
  1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program.
    2. +
+

You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee.

+
    +
  1. +

    You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions:

    +

    a) You must cause the modified files to carry prominent notices +stating that you changed the files and the date of any change.

    +

    b) You must cause any work that you distribute or publish, that in +whole or in part contains or is derived from the Program or any +part thereof, to be licensed as a whole at no charge to all third +parties under the terms of this License.

    +

    c) If the modified program normally reads commands interactively +when run, you must cause it, when started running for such +interactive use in the most ordinary way, to print or display an +announcement including an appropriate copyright notice and a +notice that there is no warranty (or else, saying that you provide +a warranty) and that users may redistribute the program under +these conditions, and telling the user how to view a copy of this +License. (Exception: if the Program itself is interactive but +does not normally print such an announcement, your work based on +the Program is not required to print an announcement.)

    +
    2. +
+

These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it.

+

Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program.

+

In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License.

+
    +
  1. +

    You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following:

    +

    a) Accompany it with the complete corresponding machine-readable +source code, which must be distributed under the terms of Sections +1 and 2 above on a medium customarily used for software interchange; or,

    +

    b) Accompany it with a written offer, valid for at least three +years, to give any third party, for a charge no more than your +cost of physically performing source distribution, a complete +machine-readable copy of the corresponding source code, to be +distributed under the terms of Sections 1 and 2 above on a medium +customarily used for software interchange; or,

    +

    c) Accompany it with the information you received as to the offer +to distribute corresponding source code. (This alternative is +allowed only for noncommercial distribution and only if you +received the program in object code or executable form with such +an offer, in accord with Subsection b above.)

    +
    2. +
+

The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable.

+

If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code.

+
    +
  1. +

    You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance.

    +
    2. +
  2. +

    You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it.

    +
    3. +
  3. +

    Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License.

    +
    4. +
  4. +

    If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program.

    +
    5. +
+

If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances.

+

It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice.

+

This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License.

+
    +
  1. +

    If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License.

    +
    2. +
  2. +

    The Free Software Foundation may publish revised and/or new versions +of the 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.

    +
    3. +
+

Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation.

+
    +
  1. +

    If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally.

    +
                        NO WARRANTY
+
    +
    2. +
  2. +

    BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.

    +
    3. +
  3. +

    IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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.

    +
                 END OF TERMS AND CONDITIONS
+
+    How to Apply These Terms to Your New Programs
+
    +
    4. +
+

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 +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found.

+
<one line to give the program's name and a brief idea of what it does.>
+Copyright (C) <year>  <name of author>
+
+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 2 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, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+

Also add information on how to contact you by electronic and paper mail.

+

If the program is interactive, make it output a short notice like this +when it starts in an interactive mode:

+
Gnomovision version 69, Copyright (C) year name of author
+Gnomovision 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' andshow c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than show w' andshow c'; they could even be +mouse-clicks or menu items--whatever suits your program.

+

You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names:

+

Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker.

+

, 1 April 1989 + Ty Coon, President of Vice

+

This 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.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/architecture/Notes/index.html b/architecture/Notes/index.html new file mode 100644 index 00000000..0eb3eaec --- /dev/null +++ b/architecture/Notes/index.html @@ -0,0 +1,695 @@ + + + + + + + + + + + + + + + + + + + + + + Troubleshooting - People Depot Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+ + + + + + + + + + + + +

Troubleshooting

+

ModHeader

+
    +
  • ModHeader will break Google drive if Authentication Bearer token is set. The Google drive website pops up a dialog saying:
    • +
+
"You are not signed in.
+You are signed out. Sign back in, then click 'Retry'.
+Retry"
+
+

The solution is to disable the Authentication header and Google drive will work as normal.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/architecture/authentication/index.html b/architecture/authentication/index.html new file mode 100644 index 00000000..b1b04b2f --- /dev/null +++ b/architecture/authentication/index.html @@ -0,0 +1,789 @@ + + + + + + + + + + + + + + + + + + + + + + Cognito authentication - People Depot Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+ + + + + + + + + + + + +

Cognito authentication

+

What is it

+

Cognito is a single sign-on system from AWS. It allows multiple apps to accept authentication from the same set of user accounts. It separates the management of users and permissions from the applications that use them.

+

Why we use cognito

+

We're invested in AWS, so we might as well use this too.

+

How we implement it

+

We're following the implementation from the djangostar tutorial.

+

These are the steps involved:

+
    +
  1. Backend downloads JWKS from Cognito User Pool on launch
    2. +
  2. User submits credentials and gets id_token and access_token
    3. +
  3. User sends request with token
    4. +
  4. Backend verifies token and processes request
    5. +
  5. User gets response from authenticated API
    6. +
+

Current Dev Setup

+
    +
  1. Created app client called "backend within the vrms-dev user pool, with ALLOW_ADMIN_USER_PASSWORD_AUTH enabled
    2. +
  2. "Domain Name" is already created at [https://hackforla-vrms-dev.auth.us-west-2.amazoncognito.com]
    3. +
  3. In "App client settings", enabled Implicit grant and openid, Callback URL [http://localhost:8000/admin]
    4. +
+

How it works now with the dev user pool and local development backend

+
    +
  1. Create a cognito user and login from the Hosted UI (from App client settings). Successful login will redirect to localhost:8000/admin with the necessary tokens
    2. +
  2. Take the access_token from the URL and make a GET request to http://localhost:8000/api/v1/me (Headers key=Authorization, value=Bearer )
    3. +
  3. Backend should return the user's profile data
    4. +
+

Notes

+

The tutorial is 2 years old now (from 2020) and there's been some change made since then.

+
    +
  1. We created an app client in Cognito for the backend to interface with. ALLOW_ADMIN_USER_PASSWORD_AUTH is the new name for the old ADMIN_NO_SRP_AUTH setting. Reference
    2. +
  2. In the custom User model step, the ugettext-lazy package is gettext-lazy for Django 4.0 Reference
    3. +
  3. The tutorial steps don't include instructions to test each step, so it's a little bit of following blindly with the help of linters until the last step.
    4. +
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 00000000..1cf13b9f Binary files /dev/null and b/assets/images/favicon.png differ diff --git a/assets/javascripts/bundle.b425cdc4.min.js b/assets/javascripts/bundle.b425cdc4.min.js new file mode 100644 index 00000000..201e5235 --- /dev/null +++ b/assets/javascripts/bundle.b425cdc4.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Ci=Object.create;var gr=Object.defineProperty;var Ri=Object.getOwnPropertyDescriptor;var ki=Object.getOwnPropertyNames,Ht=Object.getOwnPropertySymbols,Hi=Object.getPrototypeOf,yr=Object.prototype.hasOwnProperty,nn=Object.prototype.propertyIsEnumerable;var rn=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))yr.call(t,r)&&rn(e,r,t[r]);if(Ht)for(var r of Ht(t))nn.call(t,r)&&rn(e,r,t[r]);return e};var on=(e,t)=>{var r={};for(var n in e)yr.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&Ht)for(var n of Ht(e))t.indexOf(n)<0&&nn.call(e,n)&&(r[n]=e[n]);return r};var Pt=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Pi=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of ki(t))!yr.call(e,o)&&o!==r&&gr(e,o,{get:()=>t[o],enumerable:!(n=Ri(t,o))||n.enumerable});return e};var yt=(e,t,r)=>(r=e!=null?Ci(Hi(e)):{},Pi(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var sn=Pt((xr,an)=>{(function(e,t){typeof xr=="object"&&typeof an!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(xr,function(){"use strict";function e(r){var n=!0,o=!1,i=null,s={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function a(O){return!!(O&&O!==document&&O.nodeName!=="HTML"&&O.nodeName!=="BODY"&&"classList"in O&&"contains"in O.classList)}function f(O){var Qe=O.type,De=O.tagName;return!!(De==="INPUT"&&s[Qe]&&!O.readOnly||De==="TEXTAREA"&&!O.readOnly||O.isContentEditable)}function c(O){O.classList.contains("focus-visible")||(O.classList.add("focus-visible"),O.setAttribute("data-focus-visible-added",""))}function u(O){O.hasAttribute("data-focus-visible-added")&&(O.classList.remove("focus-visible"),O.removeAttribute("data-focus-visible-added"))}function p(O){O.metaKey||O.altKey||O.ctrlKey||(a(r.activeElement)&&c(r.activeElement),n=!0)}function m(O){n=!1}function d(O){a(O.target)&&(n||f(O.target))&&c(O.target)}function h(O){a(O.target)&&(O.target.classList.contains("focus-visible")||O.target.hasAttribute("data-focus-visible-added"))&&(o=!0,window.clearTimeout(i),i=window.setTimeout(function(){o=!1},100),u(O.target))}function v(O){document.visibilityState==="hidden"&&(o&&(n=!0),Y())}function Y(){document.addEventListener("mousemove",N),document.addEventListener("mousedown",N),document.addEventListener("mouseup",N),document.addEventListener("pointermove",N),document.addEventListener("pointerdown",N),document.addEventListener("pointerup",N),document.addEventListener("touchmove",N),document.addEventListener("touchstart",N),document.addEventListener("touchend",N)}function B(){document.removeEventListener("mousemove",N),document.removeEventListener("mousedown",N),document.removeEventListener("mouseup",N),document.removeEventListener("pointermove",N),document.removeEventListener("pointerdown",N),document.removeEventListener("pointerup",N),document.removeEventListener("touchmove",N),document.removeEventListener("touchstart",N),document.removeEventListener("touchend",N)}function N(O){O.target.nodeName&&O.target.nodeName.toLowerCase()==="html"||(n=!1,B())}document.addEventListener("keydown",p,!0),document.addEventListener("mousedown",m,!0),document.addEventListener("pointerdown",m,!0),document.addEventListener("touchstart",m,!0),document.addEventListener("visibilitychange",v,!0),Y(),r.addEventListener("focus",d,!0),r.addEventListener("blur",h,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var cn=Pt(Er=>{(function(e){var t=function(){try{return!!Symbol.iterator}catch(c){return!1}},r=t(),n=function(c){var u={next:function(){var p=c.shift();return{done:p===void 0,value:p}}};return r&&(u[Symbol.iterator]=function(){return u}),u},o=function(c){return encodeURIComponent(c).replace(/%20/g,"+")},i=function(c){return decodeURIComponent(String(c).replace(/\+/g," "))},s=function(){var c=function(p){Object.defineProperty(this,"_entries",{writable:!0,value:{}});var m=typeof p;if(m!=="undefined")if(m==="string")p!==""&&this._fromString(p);else if(p instanceof c){var d=this;p.forEach(function(B,N){d.append(N,B)})}else if(p!==null&&m==="object")if(Object.prototype.toString.call(p)==="[object Array]")for(var h=0;hd[0]?1:0}),c._entries&&(c._entries={});for(var p=0;p1?i(d[1]):"")}})})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Er);(function(e){var t=function(){try{var o=new e.URL("b","http://a");return o.pathname="c d",o.href==="http://a/c%20d"&&o.searchParams}catch(i){return!1}},r=function(){var o=e.URL,i=function(f,c){typeof f!="string"&&(f=String(f)),c&&typeof c!="string"&&(c=String(c));var u=document,p;if(c&&(e.location===void 0||c!==e.location.href)){c=c.toLowerCase(),u=document.implementation.createHTMLDocument(""),p=u.createElement("base"),p.href=c,u.head.appendChild(p);try{if(p.href.indexOf(c)!==0)throw new Error(p.href)}catch(O){throw new Error("URL unable to set base "+c+" due to "+O)}}var m=u.createElement("a");m.href=f,p&&(u.body.appendChild(m),m.href=m.href);var d=u.createElement("input");if(d.type="url",d.value=f,m.protocol===":"||!/:/.test(m.href)||!d.checkValidity()&&!c)throw new TypeError("Invalid URL");Object.defineProperty(this,"_anchorElement",{value:m});var h=new e.URLSearchParams(this.search),v=!0,Y=!0,B=this;["append","delete","set"].forEach(function(O){var Qe=h[O];h[O]=function(){Qe.apply(h,arguments),v&&(Y=!1,B.search=h.toString(),Y=!0)}}),Object.defineProperty(this,"searchParams",{value:h,enumerable:!0});var N=void 0;Object.defineProperty(this,"_updateSearchParams",{enumerable:!1,configurable:!1,writable:!1,value:function(){this.search!==N&&(N=this.search,Y&&(v=!1,this.searchParams._fromString(this.search),v=!0))}})},s=i.prototype,a=function(f){Object.defineProperty(s,f,{get:function(){return this._anchorElement[f]},set:function(c){this._anchorElement[f]=c},enumerable:!0})};["hash","host","hostname","port","protocol"].forEach(function(f){a(f)}),Object.defineProperty(s,"search",{get:function(){return this._anchorElement.search},set:function(f){this._anchorElement.search=f,this._updateSearchParams()},enumerable:!0}),Object.defineProperties(s,{toString:{get:function(){var f=this;return function(){return f.href}}},href:{get:function(){return this._anchorElement.href.replace(/\?$/,"")},set:function(f){this._anchorElement.href=f,this._updateSearchParams()},enumerable:!0},pathname:{get:function(){return this._anchorElement.pathname.replace(/(^\/?)/,"/")},set:function(f){this._anchorElement.pathname=f},enumerable:!0},origin:{get:function(){var f={"http:":80,"https:":443,"ftp:":21}[this._anchorElement.protocol],c=this._anchorElement.port!=f&&this._anchorElement.port!=="";return this._anchorElement.protocol+"//"+this._anchorElement.hostname+(c?":"+this._anchorElement.port:"")},enumerable:!0},password:{get:function(){return""},set:function(f){},enumerable:!0},username:{get:function(){return""},set:function(f){},enumerable:!0}}),i.createObjectURL=function(f){return o.createObjectURL.apply(o,arguments)},i.revokeObjectURL=function(f){return o.revokeObjectURL.apply(o,arguments)},e.URL=i};if(t()||r(),e.location!==void 0&&!("origin"in e.location)){var n=function(){return e.location.protocol+"//"+e.location.hostname+(e.location.port?":"+e.location.port:"")};try{Object.defineProperty(e.location,"origin",{get:n,enumerable:!0})}catch(o){setInterval(function(){e.location.origin=n()},100)}}})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Er)});var qr=Pt((Mt,Nr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Mt=="object"&&typeof Nr=="object"?Nr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Mt=="object"?Mt.ClipboardJS=r():t.ClipboardJS=r()})(Mt,function(){return function(){var e={686:function(n,o,i){"use strict";i.d(o,{default:function(){return Ai}});var s=i(279),a=i.n(s),f=i(370),c=i.n(f),u=i(817),p=i.n(u);function m(j){try{return document.execCommand(j)}catch(T){return!1}}var d=function(T){var E=p()(T);return m("cut"),E},h=d;function v(j){var T=document.documentElement.getAttribute("dir")==="rtl",E=document.createElement("textarea");E.style.fontSize="12pt",E.style.border="0",E.style.padding="0",E.style.margin="0",E.style.position="absolute",E.style[T?"right":"left"]="-9999px";var H=window.pageYOffset||document.documentElement.scrollTop;return E.style.top="".concat(H,"px"),E.setAttribute("readonly",""),E.value=j,E}var Y=function(T,E){var H=v(T);E.container.appendChild(H);var I=p()(H);return m("copy"),H.remove(),I},B=function(T){var E=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},H="";return typeof T=="string"?H=Y(T,E):T instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(T==null?void 0:T.type)?H=Y(T.value,E):(H=p()(T),m("copy")),H},N=B;function O(j){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?O=function(E){return typeof E}:O=function(E){return E&&typeof Symbol=="function"&&E.constructor===Symbol&&E!==Symbol.prototype?"symbol":typeof E},O(j)}var Qe=function(){var T=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},E=T.action,H=E===void 0?"copy":E,I=T.container,q=T.target,Me=T.text;if(H!=="copy"&&H!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(q!==void 0)if(q&&O(q)==="object"&&q.nodeType===1){if(H==="copy"&&q.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(H==="cut"&&(q.hasAttribute("readonly")||q.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(Me)return N(Me,{container:I});if(q)return H==="cut"?h(q):N(q,{container:I})},De=Qe;function $e(j){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?$e=function(E){return typeof E}:$e=function(E){return E&&typeof Symbol=="function"&&E.constructor===Symbol&&E!==Symbol.prototype?"symbol":typeof E},$e(j)}function Ei(j,T){if(!(j instanceof T))throw new TypeError("Cannot call a class as a function")}function tn(j,T){for(var E=0;E0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof I.action=="function"?I.action:this.defaultAction,this.target=typeof I.target=="function"?I.target:this.defaultTarget,this.text=typeof I.text=="function"?I.text:this.defaultText,this.container=$e(I.container)==="object"?I.container:document.body}},{key:"listenClick",value:function(I){var q=this;this.listener=c()(I,"click",function(Me){return q.onClick(Me)})}},{key:"onClick",value:function(I){var q=I.delegateTarget||I.currentTarget,Me=this.action(q)||"copy",kt=De({action:Me,container:this.container,target:this.target(q),text:this.text(q)});this.emit(kt?"success":"error",{action:Me,text:kt,trigger:q,clearSelection:function(){q&&q.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(I){return vr("action",I)}},{key:"defaultTarget",value:function(I){var q=vr("target",I);if(q)return document.querySelector(q)}},{key:"defaultText",value:function(I){return vr("text",I)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(I){var q=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return N(I,q)}},{key:"cut",value:function(I){return h(I)}},{key:"isSupported",value:function(){var I=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],q=typeof I=="string"?[I]:I,Me=!!document.queryCommandSupported;return q.forEach(function(kt){Me=Me&&!!document.queryCommandSupported(kt)}),Me}}]),E}(a()),Ai=Li},828:function(n){var o=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function s(a,f){for(;a&&a.nodeType!==o;){if(typeof a.matches=="function"&&a.matches(f))return a;a=a.parentNode}}n.exports=s},438:function(n,o,i){var s=i(828);function a(u,p,m,d,h){var v=c.apply(this,arguments);return u.addEventListener(m,v,h),{destroy:function(){u.removeEventListener(m,v,h)}}}function f(u,p,m,d,h){return typeof u.addEventListener=="function"?a.apply(null,arguments):typeof m=="function"?a.bind(null,document).apply(null,arguments):(typeof u=="string"&&(u=document.querySelectorAll(u)),Array.prototype.map.call(u,function(v){return a(v,p,m,d,h)}))}function c(u,p,m,d){return function(h){h.delegateTarget=s(h.target,p),h.delegateTarget&&d.call(u,h)}}n.exports=f},879:function(n,o){o.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},o.nodeList=function(i){var s=Object.prototype.toString.call(i);return i!==void 0&&(s==="[object NodeList]"||s==="[object HTMLCollection]")&&"length"in i&&(i.length===0||o.node(i[0]))},o.string=function(i){return typeof i=="string"||i instanceof String},o.fn=function(i){var s=Object.prototype.toString.call(i);return s==="[object Function]"}},370:function(n,o,i){var s=i(879),a=i(438);function f(m,d,h){if(!m&&!d&&!h)throw new Error("Missing required arguments");if(!s.string(d))throw new TypeError("Second argument must be a String");if(!s.fn(h))throw new TypeError("Third argument must be a Function");if(s.node(m))return c(m,d,h);if(s.nodeList(m))return u(m,d,h);if(s.string(m))return p(m,d,h);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(m,d,h){return m.addEventListener(d,h),{destroy:function(){m.removeEventListener(d,h)}}}function u(m,d,h){return Array.prototype.forEach.call(m,function(v){v.addEventListener(d,h)}),{destroy:function(){Array.prototype.forEach.call(m,function(v){v.removeEventListener(d,h)})}}}function p(m,d,h){return a(document.body,m,d,h)}n.exports=f},817:function(n){function o(i){var s;if(i.nodeName==="SELECT")i.focus(),s=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var a=i.hasAttribute("readonly");a||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),a||i.removeAttribute("readonly"),s=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var f=window.getSelection(),c=document.createRange();c.selectNodeContents(i),f.removeAllRanges(),f.addRange(c),s=f.toString()}return s}n.exports=o},279:function(n){function o(){}o.prototype={on:function(i,s,a){var f=this.e||(this.e={});return(f[i]||(f[i]=[])).push({fn:s,ctx:a}),this},once:function(i,s,a){var f=this;function c(){f.off(i,c),s.apply(a,arguments)}return c._=s,this.on(i,c,a)},emit:function(i){var s=[].slice.call(arguments,1),a=((this.e||(this.e={}))[i]||[]).slice(),f=0,c=a.length;for(f;f{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var rs=/["'&<>]/;Yo.exports=ns;function ns(e){var t=""+e,r=rs.exec(t);if(!r)return t;var n,o="",i=0,s=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function W(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var n=r.call(e),o,i=[],s;try{for(;(t===void 0||t-- >0)&&!(o=n.next()).done;)i.push(o.value)}catch(a){s={error:a}}finally{try{o&&!o.done&&(r=n.return)&&r.call(n)}finally{if(s)throw s.error}}return i}function D(e,t,r){if(r||arguments.length===2)for(var n=0,o=t.length,i;n1||a(m,d)})})}function a(m,d){try{f(n[m](d))}catch(h){p(i[0][3],h)}}function f(m){m.value instanceof et?Promise.resolve(m.value.v).then(c,u):p(i[0][2],m)}function c(m){a("next",m)}function u(m){a("throw",m)}function p(m,d){m(d),i.shift(),i.length&&a(i[0][0],i[0][1])}}function pn(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof Ee=="function"?Ee(e):e[Symbol.iterator](),r={},n("next"),n("throw"),n("return"),r[Symbol.asyncIterator]=function(){return this},r);function n(i){r[i]=e[i]&&function(s){return new Promise(function(a,f){s=e[i](s),o(a,f,s.done,s.value)})}}function o(i,s,a,f){Promise.resolve(f).then(function(c){i({value:c,done:a})},s)}}function C(e){return typeof e=="function"}function at(e){var t=function(n){Error.call(n),n.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var It=at(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(n,o){return o+1+") "+n.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Ve(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ie=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,n,o,i;if(!this.closed){this.closed=!0;var s=this._parentage;if(s)if(this._parentage=null,Array.isArray(s))try{for(var a=Ee(s),f=a.next();!f.done;f=a.next()){var c=f.value;c.remove(this)}}catch(v){t={error:v}}finally{try{f&&!f.done&&(r=a.return)&&r.call(a)}finally{if(t)throw t.error}}else s.remove(this);var u=this.initialTeardown;if(C(u))try{u()}catch(v){i=v instanceof It?v.errors:[v]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var m=Ee(p),d=m.next();!d.done;d=m.next()){var h=d.value;try{ln(h)}catch(v){i=i!=null?i:[],v instanceof It?i=D(D([],W(i)),W(v.errors)):i.push(v)}}}catch(v){n={error:v}}finally{try{d&&!d.done&&(o=m.return)&&o.call(m)}finally{if(n)throw n.error}}}if(i)throw new It(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)ln(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Ve(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Ve(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Sr=Ie.EMPTY;function jt(e){return e instanceof Ie||e&&"closed"in e&&C(e.remove)&&C(e.add)&&C(e.unsubscribe)}function ln(e){C(e)?e():e.unsubscribe()}var Le={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var st={setTimeout:function(e,t){for(var r=[],n=2;n0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var n=this,o=this,i=o.hasError,s=o.isStopped,a=o.observers;return i||s?Sr:(this.currentObservers=null,a.push(r),new Ie(function(){n.currentObservers=null,Ve(a,r)}))},t.prototype._checkFinalizedStatuses=function(r){var n=this,o=n.hasError,i=n.thrownError,s=n.isStopped;o?r.error(i):s&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,n){return new xn(r,n)},t}(F);var xn=function(e){ie(t,e);function t(r,n){var o=e.call(this)||this;return o.destination=r,o.source=n,o}return t.prototype.next=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.next)===null||o===void 0||o.call(n,r)},t.prototype.error=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.error)===null||o===void 0||o.call(n,r)},t.prototype.complete=function(){var r,n;(n=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||n===void 0||n.call(r)},t.prototype._subscribe=function(r){var n,o;return(o=(n=this.source)===null||n===void 0?void 0:n.subscribe(r))!==null&&o!==void 0?o:Sr},t}(x);var Et={now:function(){return(Et.delegate||Date).now()},delegate:void 0};var wt=function(e){ie(t,e);function t(r,n,o){r===void 0&&(r=1/0),n===void 0&&(n=1/0),o===void 0&&(o=Et);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=n,i._timestampProvider=o,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=n===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,n),i}return t.prototype.next=function(r){var n=this,o=n.isStopped,i=n._buffer,s=n._infiniteTimeWindow,a=n._timestampProvider,f=n._windowTime;o||(i.push(r),!s&&i.push(a.now()+f)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var n=this._innerSubscribe(r),o=this,i=o._infiniteTimeWindow,s=o._buffer,a=s.slice(),f=0;f0?e.prototype.requestAsyncId.call(this,r,n,o):(r.actions.push(this),r._scheduled||(r._scheduled=ut.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,n,o){var i;if(o===void 0&&(o=0),o!=null?o>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,n,o);var s=r.actions;n!=null&&((i=s[s.length-1])===null||i===void 0?void 0:i.id)!==n&&(ut.cancelAnimationFrame(n),r._scheduled=void 0)},t}(Wt);var Sn=function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var n=this._scheduled;this._scheduled=void 0;var o=this.actions,i;r=r||o.shift();do if(i=r.execute(r.state,r.delay))break;while((r=o[0])&&r.id===n&&o.shift());if(this._active=!1,i){for(;(r=o[0])&&r.id===n&&o.shift();)r.unsubscribe();throw i}},t}(Dt);var Oe=new Sn(wn);var M=new F(function(e){return e.complete()});function Vt(e){return e&&C(e.schedule)}function Cr(e){return e[e.length-1]}function Ye(e){return C(Cr(e))?e.pop():void 0}function Te(e){return Vt(Cr(e))?e.pop():void 0}function zt(e,t){return typeof Cr(e)=="number"?e.pop():t}var pt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Nt(e){return C(e==null?void 0:e.then)}function qt(e){return C(e[ft])}function Kt(e){return Symbol.asyncIterator&&C(e==null?void 0:e[Symbol.asyncIterator])}function Qt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function zi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Yt=zi();function Gt(e){return C(e==null?void 0:e[Yt])}function Bt(e){return un(this,arguments,function(){var r,n,o,i;return $t(this,function(s){switch(s.label){case 0:r=e.getReader(),s.label=1;case 1:s.trys.push([1,,9,10]),s.label=2;case 2:return[4,et(r.read())];case 3:return n=s.sent(),o=n.value,i=n.done,i?[4,et(void 0)]:[3,5];case 4:return[2,s.sent()];case 5:return[4,et(o)];case 6:return[4,s.sent()];case 7:return s.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function Jt(e){return C(e==null?void 0:e.getReader)}function U(e){if(e instanceof F)return e;if(e!=null){if(qt(e))return Ni(e);if(pt(e))return qi(e);if(Nt(e))return Ki(e);if(Kt(e))return On(e);if(Gt(e))return Qi(e);if(Jt(e))return Yi(e)}throw Qt(e)}function Ni(e){return new F(function(t){var r=e[ft]();if(C(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function qi(e){return new F(function(t){for(var r=0;r=2;return function(n){return n.pipe(e?A(function(o,i){return e(o,i,n)}):de,ge(1),r?He(t):Dn(function(){return new Zt}))}}function Vn(){for(var e=[],t=0;t=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new x}:t,n=e.resetOnError,o=n===void 0?!0:n,i=e.resetOnComplete,s=i===void 0?!0:i,a=e.resetOnRefCountZero,f=a===void 0?!0:a;return function(c){var u,p,m,d=0,h=!1,v=!1,Y=function(){p==null||p.unsubscribe(),p=void 0},B=function(){Y(),u=m=void 0,h=v=!1},N=function(){var O=u;B(),O==null||O.unsubscribe()};return y(function(O,Qe){d++,!v&&!h&&Y();var De=m=m!=null?m:r();Qe.add(function(){d--,d===0&&!v&&!h&&(p=$r(N,f))}),De.subscribe(Qe),!u&&d>0&&(u=new rt({next:function($e){return De.next($e)},error:function($e){v=!0,Y(),p=$r(B,o,$e),De.error($e)},complete:function(){h=!0,Y(),p=$r(B,s),De.complete()}}),U(O).subscribe(u))})(c)}}function $r(e,t){for(var r=[],n=2;ne.next(document)),e}function K(e,t=document){return Array.from(t.querySelectorAll(e))}function z(e,t=document){let r=ce(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function ce(e,t=document){return t.querySelector(e)||void 0}function _e(){return document.activeElement instanceof HTMLElement&&document.activeElement||void 0}function tr(e){return L(b(document.body,"focusin"),b(document.body,"focusout")).pipe(ke(1),l(()=>{let t=_e();return typeof t!="undefined"?e.contains(t):!1}),V(e===_e()),J())}function Xe(e){return{x:e.offsetLeft,y:e.offsetTop}}function Kn(e){return L(b(window,"load"),b(window,"resize")).pipe(Ce(0,Oe),l(()=>Xe(e)),V(Xe(e)))}function rr(e){return{x:e.scrollLeft,y:e.scrollTop}}function dt(e){return L(b(e,"scroll"),b(window,"resize")).pipe(Ce(0,Oe),l(()=>rr(e)),V(rr(e)))}var Yn=function(){if(typeof Map!="undefined")return Map;function e(t,r){var n=-1;return t.some(function(o,i){return o[0]===r?(n=i,!0):!1}),n}return function(){function t(){this.__entries__=[]}return Object.defineProperty(t.prototype,"size",{get:function(){return this.__entries__.length},enumerable:!0,configurable:!0}),t.prototype.get=function(r){var n=e(this.__entries__,r),o=this.__entries__[n];return o&&o[1]},t.prototype.set=function(r,n){var o=e(this.__entries__,r);~o?this.__entries__[o][1]=n:this.__entries__.push([r,n])},t.prototype.delete=function(r){var n=this.__entries__,o=e(n,r);~o&&n.splice(o,1)},t.prototype.has=function(r){return!!~e(this.__entries__,r)},t.prototype.clear=function(){this.__entries__.splice(0)},t.prototype.forEach=function(r,n){n===void 0&&(n=null);for(var o=0,i=this.__entries__;o0},e.prototype.connect_=function(){!Wr||this.connected_||(document.addEventListener("transitionend",this.onTransitionEnd_),window.addEventListener("resize",this.refresh),va?(this.mutationsObserver_=new MutationObserver(this.refresh),this.mutationsObserver_.observe(document,{attributes:!0,childList:!0,characterData:!0,subtree:!0})):(document.addEventListener("DOMSubtreeModified",this.refresh),this.mutationEventsAdded_=!0),this.connected_=!0)},e.prototype.disconnect_=function(){!Wr||!this.connected_||(document.removeEventListener("transitionend",this.onTransitionEnd_),window.removeEventListener("resize",this.refresh),this.mutationsObserver_&&this.mutationsObserver_.disconnect(),this.mutationEventsAdded_&&document.removeEventListener("DOMSubtreeModified",this.refresh),this.mutationsObserver_=null,this.mutationEventsAdded_=!1,this.connected_=!1)},e.prototype.onTransitionEnd_=function(t){var r=t.propertyName,n=r===void 0?"":r,o=ba.some(function(i){return!!~n.indexOf(i)});o&&this.refresh()},e.getInstance=function(){return this.instance_||(this.instance_=new e),this.instance_},e.instance_=null,e}(),Gn=function(e,t){for(var r=0,n=Object.keys(t);r0},e}(),Jn=typeof WeakMap!="undefined"?new WeakMap:new Yn,Xn=function(){function e(t){if(!(this instanceof e))throw new TypeError("Cannot call a class as a function.");if(!arguments.length)throw new TypeError("1 argument required, but only 0 present.");var r=ga.getInstance(),n=new La(t,r,this);Jn.set(this,n)}return e}();["observe","unobserve","disconnect"].forEach(function(e){Xn.prototype[e]=function(){var t;return(t=Jn.get(this))[e].apply(t,arguments)}});var Aa=function(){return typeof nr.ResizeObserver!="undefined"?nr.ResizeObserver:Xn}(),Zn=Aa;var eo=new x,Ca=$(()=>k(new Zn(e=>{for(let t of e)eo.next(t)}))).pipe(g(e=>L(ze,k(e)).pipe(R(()=>e.disconnect()))),X(1));function he(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ye(e){return Ca.pipe(S(t=>t.observe(e)),g(t=>eo.pipe(A(({target:r})=>r===e),R(()=>t.unobserve(e)),l(()=>he(e)))),V(he(e)))}function bt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function ar(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}var to=new x,Ra=$(()=>k(new IntersectionObserver(e=>{for(let t of e)to.next(t)},{threshold:0}))).pipe(g(e=>L(ze,k(e)).pipe(R(()=>e.disconnect()))),X(1));function sr(e){return Ra.pipe(S(t=>t.observe(e)),g(t=>to.pipe(A(({target:r})=>r===e),R(()=>t.unobserve(e)),l(({isIntersecting:r})=>r))))}function ro(e,t=16){return dt(e).pipe(l(({y:r})=>{let n=he(e),o=bt(e);return r>=o.height-n.height-t}),J())}var cr={drawer:z("[data-md-toggle=drawer]"),search:z("[data-md-toggle=search]")};function no(e){return cr[e].checked}function Ke(e,t){cr[e].checked!==t&&cr[e].click()}function Ue(e){let t=cr[e];return b(t,"change").pipe(l(()=>t.checked),V(t.checked))}function ka(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ha(){return L(b(window,"compositionstart").pipe(l(()=>!0)),b(window,"compositionend").pipe(l(()=>!1))).pipe(V(!1))}function oo(){let e=b(window,"keydown").pipe(A(t=>!(t.metaKey||t.ctrlKey)),l(t=>({mode:no("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),A(({mode:t,type:r})=>{if(t==="global"){let n=_e();if(typeof n!="undefined")return!ka(n,r)}return!0}),pe());return Ha().pipe(g(t=>t?M:e))}function le(){return new URL(location.href)}function ot(e){location.href=e.href}function io(){return new x}function ao(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)ao(e,r)}function _(e,t,...r){let n=document.createElement(e);if(t)for(let o of Object.keys(t))typeof t[o]!="undefined"&&(typeof t[o]!="boolean"?n.setAttribute(o,t[o]):n.setAttribute(o,""));for(let o of r)ao(n,o);return n}function fr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function so(){return location.hash.substring(1)}function Dr(e){let t=_("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Pa(e){return L(b(window,"hashchange"),e).pipe(l(so),V(so()),A(t=>t.length>0),X(1))}function co(e){return Pa(e).pipe(l(t=>ce(`[id="${t}"]`)),A(t=>typeof t!="undefined"))}function Vr(e){let t=matchMedia(e);return er(r=>t.addListener(()=>r(t.matches))).pipe(V(t.matches))}function fo(){let e=matchMedia("print");return L(b(window,"beforeprint").pipe(l(()=>!0)),b(window,"afterprint").pipe(l(()=>!1))).pipe(V(e.matches))}function zr(e,t){return e.pipe(g(r=>r?t():M))}function ur(e,t={credentials:"same-origin"}){return ue(fetch(`${e}`,t)).pipe(fe(()=>M),g(r=>r.status!==200?Ot(()=>new Error(r.statusText)):k(r)))}function We(e,t){return ur(e,t).pipe(g(r=>r.json()),X(1))}function uo(e,t){let r=new DOMParser;return ur(e,t).pipe(g(n=>n.text()),l(n=>r.parseFromString(n,"text/xml")),X(1))}function pr(e){let t=_("script",{src:e});return $(()=>(document.head.appendChild(t),L(b(t,"load"),b(t,"error").pipe(g(()=>Ot(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(l(()=>{}),R(()=>document.head.removeChild(t)),ge(1))))}function po(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function lo(){return L(b(window,"scroll",{passive:!0}),b(window,"resize",{passive:!0})).pipe(l(po),V(po()))}function mo(){return{width:innerWidth,height:innerHeight}}function ho(){return b(window,"resize",{passive:!0}).pipe(l(mo),V(mo()))}function bo(){return G([lo(),ho()]).pipe(l(([e,t])=>({offset:e,size:t})),X(1))}function lr(e,{viewport$:t,header$:r}){let n=t.pipe(ee("size")),o=G([n,r]).pipe(l(()=>Xe(e)));return G([r,t,o]).pipe(l(([{height:i},{offset:s,size:a},{x:f,y:c}])=>({offset:{x:s.x-f,y:s.y-c+i},size:a})))}(()=>{function e(n,o){parent.postMessage(n,o||"*")}function t(...n){return n.reduce((o,i)=>o.then(()=>new Promise(s=>{let a=document.createElement("script");a.src=i,a.onload=s,document.body.appendChild(a)})),Promise.resolve())}var r=class extends EventTarget{constructor(n){super(),this.url=n,this.m=i=>{i.source===this.w&&(this.dispatchEvent(new MessageEvent("message",{data:i.data})),this.onmessage&&this.onmessage(i))},this.e=(i,s,a,f,c)=>{if(s===`${this.url}`){let u=new ErrorEvent("error",{message:i,filename:s,lineno:a,colno:f,error:c});this.dispatchEvent(u),this.onerror&&this.onerror(u)}};let o=document.createElement("iframe");o.hidden=!0,document.body.appendChild(this.iframe=o),this.w.document.open(),this.w.document.write(` + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+ + + + + + + + + + + + +

Add new model and API endpoints

+

This guide aims to enable developers with little or no django experience to add django models and API endpoints to the project. Most code examples are followed by detailed explanations.

+

The developer will have exposure to the following in this document:

+
    +
  • python
    • +
  • django
    • +
  • django rest framework
    • +
  • relational database through the Django ORM (object-relational mapper)
    • +
  • data types
    • +
  • object-oriented concepts (object, inheritance, composition)
    • +
  • unit testing
    • +
  • API design
    • +
  • command line
    • +
+

This guide assumes the developer has followed the contributing doc and have forked and created a local branch to work on this. The development server would be already running in the background and will automatically apply the changes when we save the files.

+

We will choose the recurring_event issue as an example. Our goal is to create a database table and an API that a client can use to work with the data. The work is split into 3 testable components: the model, the admin site, and the API

+

Let's start!

+

The model

+

Add the model in django

+

Add the following to app/core/models.py

+
class RecurringEvent(AbstractBaseModel):
+    """
+    Recurring Events
+    """
+
+    name = models.CharField(max_length=255)
+    start_time = models.TimeField("Start", null=True, blank=True)
+    duration_in_min = models.IntegerField(null=True, blank=True)
+    video_conference_url = models.URLField(blank=True)
+    additional_info = models.TextField(blank=True)
+
+    project = models.ForeignKey(Project, on_delete=models.CASCADE)
+    # location_id = models.ForeignKey("Location", on_delete=models.DO_NOTHING)
+    # event_type_id = models.ForeignKey("EventType", on_delete=models.DO_NOTHING)
+    # brigade_id = models.ForeignKey("Brigade", on_delete=models.DO_NOTHING)
+    # day_of_week = models.ForeignKey("DayOfWeek", on_delete=models.DO_NOTHING)
+    # must_roles = models.ManyToManyField("Role")
+    # should_roles = models.ManyToManyField("Role")
+    # could_roles = models.ManyToManyField("Role")
+    # frequency_id = models.ForeignKey("Frequency", on_delete=models.DO_NOTHING)
+
+    def __str__(self):
+        return f"{self.name}"
+
+

link to code

+
    +
  1. We inherit all models from AbstractBaseModel, which provides a uuid primary key, created_at, and updated_at timestamps. In the Github issue, these fields might be called id, created, and updated. There's no need to add those.
    2. +
  2. Most fields should not be required. Text fields should be blank=True, data fields should be null=True.
    3. +
  3. The data types in the github issue may be given in database column types such as INTEGER, VARCHAR, but we need to convert them into Django field types when defining the model.
    4. +
  4. VARCHAR can be either CharField or TextField.
    5. +
  5. CharField has a max_length, which makes it useful for finite length text data. We're going default to giving them max_length=255 unless there's a better value like max_length=2 for state abbreviation.
    6. +
  6. TextField doesn't have a maximum length, which makes it ideal for large text fields such as description.
    7. +
  7. Try to add the relationships to non-existent models, but comment them out. Another developer will complete them when they go to implement those models.
    8. +
  8. Always override the __str__ function to output something more meaningful than the default. It lets us do a quick test of the model by calling str([model]). It's also useful for the admin site model list view.
    9. +
+

Run migrations to generate database migration files

+
./scripts/migrate.sh
+
+

Write a simple test

+

Since we overrode the __str__ function, we need to write a test for it.

+
    +
  1. Add a fixture for the model
    2. +
+

Fixtures are reusable code that can be used in multiple tests by declaring them as parameters of the test case. In this example, we show both defining a fixture (recurring_event) and using another fixture (project).

+

Note: The conftest file is meant to hold shared test fixtures, among other things. The fixtures have directory scope.

+

Add the following to app/core/tests/conftest.py

+
@pytest.fixture
+def recurring_event(project):
+    return RecurringEvent.objects.create(name="Test Recurring Event", project=project)
+
+

link to code

+
    +
  1. We name the fixture after the model name (recurring_event).
    2. +
  2. This model makes use of the project model as a foreign key relation, so we pass in the project fixture, which creates a project model.
    3. +
  3. +

    We create an object of the new model, passing in at least the required fields. In this case, we passed in enough arguments to use the __str__ method in a test.

    +
    4. +
  4. +

    Add a test case

    +
    5. +
+

When creating Django models, there's no need to test the CRUD functionality since Django itself is well-tested and we can expect it to generate the correct CRUD functionality. Feel free to write some tests for practice. What really needs testing are any custom code that's not part of Django. Sometimes we need to override the default Django behavior and that should be tested.

+

Here's a basic test to see that the model stores its name.

+

Add the following to app/core/tests/test_models.py

+
def test_recurring_event(recurring_event):
+    assert str(recurring_event) == "Test Recurring Event"
+
+

link to code

+
    +
  1. Pass in our fixture so that the model object is created for us.
    2. +
  2. The __str__ method should be tested since it's an override of the default Django method.
    3. +
  3. +

    Write assertion(s) to check that what's passed into the model is what it contains. The simplest thing to check is the __str__ method.

    +
    4. +
  4. +

    Run the test script to show it passing

    +
    5. +
+
./scripts/test.sh
+
+

Check point 1

+

This is a good place to pause, check, and commit progress.

+
    +
  1. Run pre-commit checks
    2. +
+
./scripts/precommit-check.sh
+
+
    +
  1. Add and commit changes
    2. +
+
git add -A
+git commit -m "feat: add model: recurring_event"
+
+

The admin site

+

Django comes with an admin site interface that allows admin users to view and change the data in the models. It's essentially a database viewer.

+

Register the model with the admin site

+
    +
  1. Import the new model
    2. +
+
from .models import RecurringEvent
+
+

link to code

+
    +
  1. Register the model
    2. +
+
@admin.register(RecurringEvent)
+class RecurringEventAdmin(admin.ModelAdmin):
+    list_display = (
+        "name",
+        "start_time",
+        "duration_in_min",
+    )
+
+

link to code

+
    +
  1. We declare a ModelAdmin class so we can customize the fields that we expose to the admin interface.
    2. +
  2. We use the register decorator to register the class with the admin site.
    3. +
  3. list_display controls what's shown in the list view
    4. +
  4. list_filter adds filter controls to declared fields (useful, but not shown in this example).
    5. +
+

View the admin site to see that everything's working and there are no issues, which should be the case unless there's custom input fields creating problems

+
    +
  1. +

    See the contributing doc section on "Build and run using Docker locally" for how to view the admin interface.

    +
    2. +
  2. +

    Example of a custom field (as opposed to the built-in ones)

    +
    3. +
+
time_zone = TimeZoneField(blank=True, use_pytz=False, default="America/Los_Angeles")
+
+

link to code

+
    +
  1. Having a misconfigured or buggy custom field could cause the admin site to crash and the developer will need to look at the debug message and resolve it.
    2. +
+

Tests

+
    +
  1. Feel free to write tests for the admin. There's no example for it yet.
    2. +
  2. The reason there's no tests is that the admin site is independent of the API functionality, and we're mainly interested in the API part.
    3. +
  3. When the time comes that we depend on the admin interface, we will need to have tests for the needed functionalities.
    4. +
+

Check point 2

+

This is a good place to pause, check, and commit progress.

+
    +
  1. Run pre-commit checks
    2. +
+
./scripts/precommit-check.sh
+
+
    +
  1. Add and commit changes
    2. +
+
git add -A
+git commit -m "feat: register admin: recurring_event"
+
+

The API

+

There's several components to adding API endpoints: Model(already done), Serializer, View, and Router.

+

Add serializer

+

This is code that serializes objects into strings for the API endpoints, and deserializes strings into object when we receive data from the client.

+
    +
  1. Import the new model
    2. +
+
from core.models import RecurringEvent
+
+

link to code

+
    +
  1. Add a serializer class
    2. +
+
class RecurringEventSerializer(serializers.ModelSerializer):
+    """Used to retrieve recurring_event info"""
+
+    class Meta:
+        model = RecurringEvent
+        fields = (
+            "uuid",
+            "name",
+            "start_time",
+            "duration_in_min",
+            "video_conference_url",
+            "additional_info",
+            "project",
+        )
+        read_only_fields = (
+            "uuid",
+            "created_at",
+            "updated_at",
+        )
+
+

link to code

+
    +
  1. We inherit from ModelSerializer. It knows how to serialize/deserialize the Django built-in data fields so we don't have to write the code to do it.
    2. +
  2. We do need to pass in the model, the fields we want to expose through the API, and any read_only_fields.
    3. +
  3. +

    uuid, created_at, and updated_at are managed by automations and are always read-only.

    +
    4. +
  4. +

    Custom data fields may need extra code in the serializer

    +
    5. +
+
time_zone = TimeZoneSerializerField(use_pytz=False)
+
+

link to code

+
    +
  1. +

    This non-built-in model field provides a serializer so we just point to it.

    +
    2. +
  2. +

    Custom validators if we need them

    +
    3. +
+

We will need to write custom validators here if we want custom behavior, such as validating URL strings and limit them to the github user profile pattern using regular expression, for example.

+
Example here when we have one
+
+

Add viewset

+

Viewset defines the set of API endpoints for the model.

+
    +
  1. Import the serializer
    2. +
+
from .serializers import RecurringEventSerializer
+
+

link to code

+
    +
  1. Add the viewset and CRUD API endpoint descriptions
    2. +
+
@extend_schema_view(
+    list=extend_schema(description="Return a list of all the recurring events"),
+    create=extend_schema(description="Create a new recurring event"),
+    retrieve=extend_schema(description="Return the details of a recurring event"),
+    destroy=extend_schema(description="Delete a recurring event"),
+    update=extend_schema(description="Update a recurring event"),
+    partial_update=extend_schema(description="Patch a recurring event"),
+)
+class RecurringEventViewSet(viewsets.ModelViewSet):
+    permission_classes = [IsAuthenticated]
+    queryset = RecurringEvent.objects.all()
+    serializer_class = RecurringEventSerializer
+
+

link to code

+
    +
  1. We inherit from ModelViewSet, which provides a default view implementation of all 6 CRUD actions: create, retrieve, partial_update, update, destroy, list.
    2. +
  2. We use the extend_schema_view decorator to attach the API doc strings to the viewset. They are usually defined as docstrings of the corresponding function definitions inside the viewset. Since we use ModelViewSet, there's nowhere to put the docstrings but above the viewset.
    3. +
  3. The minimum code we need with ModelViewSet are the queryset, and the serializer_class.
    4. +
  4. Permissions
      +
    1. For now use permission_classes = [IsAuthenticated]
      2. +
    2. It doesn't control permissions the way we want, but we will fix it later.
      3. +
    +
    5. +
+

Extended example

+

This example shows how to add a filter params. It's done for the user model as a requirement from VRMS.

+
    +
  1. Here's a more complex API doc example (this example is using the User model's ViewSet)
    2. +
+
@extend_schema_view(
+    list=extend_schema(
+        summary="Users List",
+        description="Return a list of all the existing users",
+        parameters=[
+            OpenApiParameter(
+                name="email",
+                type=str,
+                description="Filter by email address",
+                examples=[
+                    OpenApiExample(
+                        "Example 1",
+                        summary="Demo email",
+                        description="get the demo user",
+                        value="demo-email@email.com,",
+                    ),
+                ],
+            ),
+            OpenApiParameter(
+                name="username",
+                type=OpenApiTypes.STR,
+                location=OpenApiParameter.QUERY,
+                description="Filter by username",
+                examples=[
+                    OpenApiExample(
+                        "Example 1",
+                        summary="Demo username",
+                        description="get the demo user",
+                        value="demo-user",
+                    ),
+                ],
+            ),
+        ],
+    ),
+    create=extend_schema(description="Create a new user"),
+    retrieve=extend_schema(description="Return the given user"),
+    destroy=extend_schema(description="Delete the given user"),
+    update=extend_schema(description="Update the given user"),
+    partial_update=extend_schema(description="Partially update the given user"),
+)
+class UserViewSet(viewsets.ModelViewSet):
+
+

link to code

+
    +
  1. Define strings for all 6 actions: create, retrieve, partial_update, update, destroy, list.
    2. +
  2. +

    This one is fancy and provides examples of data to pass into the query params. It's probably more than we need right now.

    +
      +
    1. The examples array can hold multiple examples.
        +
      1. Example ID string has to be unique but is not displayed.
        2. +
      2. summary string appears as an option in the dropdown.
        3. +
      3. description is displayed in the example.
        4. +
      +
      2. +
    +
    3. +
  3. +

    Add any query params according to the requirements (this example is using the User model's ViewSet)

    +
    4. +
+
class UserViewSet(viewsets.ModelViewSet):
+    ...
+
+    def get_queryset(self):
+        """
+        Optionally filter users by an 'email' and/or 'username' query paramerter in the URL
+        """
+        queryset = get_user_model().objects.all()
+        email = self.request.query_params.get("email")
+        if email is not None:
+            queryset = queryset.filter(email=email)
+        username = self.request.query_params.get("username")
+        if username is not None:
+            queryset = queryset.filter(username=username)
+        return queryset
+
+

link to code

+
    +
  1. Notice the queryset property is now the get_queryset(() function which returns the queryset.
    2. +
  2. The get_queryset() function overrides the default and lets us filter the objects returned to the client if they pass in a query param.
    3. +
  3. Start with all the model objects and filter them based on any available query params.
    4. +
+

Register API endpoints to the router

+
    +
  1. Import the viewset.
    2. +
+
from .views import RecurringEventViewSet
+
+

link to code

+
    +
  1. Register the viewset to the router
    2. +
+
router.register(r"recurring-events", RecurringEventViewSet, basename="recurring-event")
+
+

link to code

+
    +
  1. First param is the URL prefix use in the API routes. It is, by convention, plural
      +
    • This would show up in the URL like this: http://localhost/api/v1/recuring-events/ and http://localhost/api/v1/recuring-events/<uuid>
      • +
    +
    2. +
  2. Second param is the viewset class which defines the API actions
    3. +
  3. basename is the name used for generating the endpoint names, such as [basename]-list, [basename]-detail, etc. It's in the singular form. This is automatically generated if the viewset definition contains a queryset attribute, but it's required if the viewset overrides that with the get_queryset function
      +
    • reverse("recurring-event-list") would return http://localhost/api/v1/recuring-events/
      • +
    +
    4. +
+

Add API tests

+

For the CRUD operations, since we're using ModelViewSet where all the actions are provided by rest_framework and well-tested, it's not necessary to have test cases for them. But here's an example of one.

+
    +
  1. Import API URL
    2. +
+
RECURRING_EVENTS_URL = reverse("recurring-event-list")
+
+

link to code

+
    +
  1. Add test case
    2. +
+
def test_create_recurring_event(auth_client, project):
+    """Test that we can create a recurring event"""
+
+    payload = {
+        "name": "Test Weekly team meeting",
+        "start_time": "18:00:00",
+        "duration_in_min": 60,
+        "video_conference_url": "https://zoom.com/link",
+        "additional_info": "Test description",
+        "project": project.uuid,
+    }
+    res = auth_client.post(RECURRING_EVENTS_URL, payload)
+    assert res.status_code == status.HTTP_201_CREATED
+    assert res.data["name"] == payload["name"]
+
+

link to code

+
    +
  1. Given
      +
    1. Pass in the necessary fixtures
      2. +
    2. Construct the payload
      3. +
    +
    2. +
  2. When
      +
    1. Create the object
      2. +
    +
    3. +
  3. +

    Then

    +
      +
    1. Check that it's created via status code
      2. +
    2. Maybe also check the data. A real test should check all the data, but we're kind of relying on django to have already tested this.
      3. +
    +
    4. +
  4. +

    Run the test script to show it passing

    +
    5. +
+
./scripts/test.sh
+
+

Check point 3

+

This is a good place to pause, check, and commit progress.

+
    +
  1. Run pre-commit checks
    2. +
+
./scripts/precommit-check.sh
+
+
    +
  1. Add and commit changes
    2. +
+
git add -A
+git commit -m "feat: add endpoints: recurring_event"
+
+

Push the code and start a PR

+

Refer to the contributing doc section on "Push to upstream origin" onward.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..80a6dfbf --- /dev/null +++ b/index.html @@ -0,0 +1,765 @@ + + + + + + + + + + + + + + + + + + + + People Depot Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+ + + + + + + + + + + + +

pre-commit

+

PeopleDepot

+

PeopleDepot is a project of Hack for LA/Civic Tech Structure Inc. 501(c)(3). PeopleDepot aims to provide a single source of truth as the backend infrastructure and data store for Hack for LA projects, including data about people, program areas, and projects. PeopleDepot uses PostgreSQL for its database and Django as the backend data model framework with Django REST Framework for the API layer. PeopleDepot's goal is to serve as a repository of information for other infrastructure projects (e.g., VRMS, Hack for LA Website, Civic Tech Index, Tables, etc).

+

Project context

+

The hardest part about running a large organization using only free or open source tools and technologies is how to manage the flow of information and provide relevant info to all the people and projects that need it. Managing multiple databases inefficiently can end up taking more time than the projects themselves. This project seeks to create a maintainable database infrastructure that is synchronized.

+

In the process, it should allow for further automation and do away with manual storage of duplicate information across projects, which includes: +- Recruiting members (Website: Project info and meeting times) +- Onboarding members to resources (e.g., GitHub, Google Calendar, Google Drive, Google Docs, Google Sheets, etc.) +- Helping members find roles (Civic Tech Jobs: roles and project info) +- Managing team permissions (VRMS: GitHub, Google Calendar, Google Drives, etc.)

+

Technology used

+ +

How to contribute

+
    +
  1. Join our organization by going through Hack for LA Onboarding. It's free to join!
    2. +
  2. Read the onboarding section of our Wiki.
    3. +
  3. Read our Contributing Guidelines and follow the instructions there.
    4. +
+

Contact info

+

Contact us in the #people-depot channel on Slack.

+

Licensing

+

This repository uses the GNU General Public License (v2.0).

+ + + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 00000000..c086fab6 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#peopledepot","title":"PeopleDepot","text":"

PeopleDepot is a project of Hack for LA/Civic Tech Structure Inc. 501(c)(3). PeopleDepot aims to provide a single source of truth as the backend infrastructure and data store for Hack for LA projects, including data about people, program areas, and projects. PeopleDepot uses PostgreSQL for its database and Django as the backend data model framework with Django REST Framework for the API layer. PeopleDepot's goal is to serve as a repository of information for other infrastructure projects (e.g., VRMS, Hack for LA Website, Civic Tech Index, Tables, etc).

"},{"location":"#project-context","title":"Project context","text":"

The hardest part about running a large organization using only free or open source tools and technologies is how to manage the flow of information and provide relevant info to all the people and projects that need it. Managing multiple databases inefficiently can end up taking more time than the projects themselves. This project seeks to create a maintainable database infrastructure that is synchronized.

In the process, it should allow for further automation and do away with manual storage of duplicate information across projects, which includes: - Recruiting members (Website: Project info and meeting times) - Onboarding members to resources (e.g., GitHub, Google Calendar, Google Drive, Google Docs, Google Sheets, etc.) - Helping members find roles (Civic Tech Jobs: roles and project info) - Managing team permissions (VRMS: GitHub, Google Calendar, Google Drives, etc.)

"},{"location":"#technology-used","title":"Technology used","text":"
  • Docker
  • Django
  • DjangoRestFramework
  • PostgreSQL
"},{"location":"#how-to-contribute","title":"How to contribute","text":"
  1. Join our organization by going through Hack for LA Onboarding. It's free to join!
  2. Read the onboarding section of our Wiki.
  3. Read our Contributing Guidelines and follow the instructions there.
"},{"location":"#contact-info","title":"Contact info","text":"

Contact us in the #people-depot channel on Slack.

"},{"location":"#licensing","title":"Licensing","text":"

This repository uses the GNU General Public License (v2.0).

"},{"location":"CONTRIBUTING/","title":"Contributing","text":"

Thank you for volunteering your time! The following is a set of guidelines for contributing to the peopledepot repository, which is hosted on GitHub.

Please make sure you have completed the onboarding process which includes joining the Hack for LA Slack, GitHub, and Google Drive. If you have not been onboarded, see the Getting Started Page. Workshop attendees are granted a temporary exception from this requirement.

"},{"location":"CONTRIBUTING/#1-joining-repository-team","title":"1. Joining Repository Team","text":"

This step is optional if this is your first time fixing an issue and you want to try fixing an issue without this step.

In the hfla-site Slack channel, send an introductory message with your GitHub handle/username asking to be added to the Hack for LA peopledepot GitHub repository, have access to the Google Docs Drive, and Figma.

NOTE: Once you have accepted the GitHub invite (comes via email or in your GitHub notifications), please do the following:

Make your own Hack for LA GitHub organization membership public by following this guide.

"},{"location":"CONTRIBUTING/#2-setting-up-development-environment","title":"2. Setting Up Development Environment","text":""},{"location":"CONTRIBUTING/#21-pre-requisites","title":"2.1 Pre-requisites","text":""},{"location":"CONTRIBUTING/#211-github-account","title":"2.1.1 GitHub account","text":"

See here for creating a GitHub account. If you are not familiar with Git, this tutorial is recommended.

"},{"location":"CONTRIBUTING/#212-two-factor-authentication","title":"2.1.2 Two-factor authentication","text":"

Set up two-factor authentication on your account by following this guide.

"},{"location":"CONTRIBUTING/#213-text-editor","title":"2.1.3 Text editor","text":"

VS Code is recommended, but feel free to use a text editor of your choice.

"},{"location":"CONTRIBUTING/#214-install-git","title":"2.1.4 Install Git","text":"

Before cloning your forked repository to your local machine, you must have Git installed. You can find instructions for installing Git for your operating system here.

Installation Guide for Windows Users - we recommend installing Windows Subsystem for Linux (WSL). WSL provides a Linux-compatible environment that can prevent common errors during script execution. - After setting up WSL, install Git directly from the Linux terminal. This method can help avoid complications that sometimes arise when using Git Bash on Windows. - If you prefer Git Bash or encounter errors related to line endings when running scripts, the problem might be due to file conversions in Windows. To address this, configure Git as follows: 

    git config --system set autocrlf=false\n
Feel free to reach out in the Hack for LA Slack channel if you encounter any errors while running scripts on Windows.

Please note that if you have a Mac the page offers several options (see other option, if you need to conserve hard drive space) including:

  • an \u201ceasiest\u201d option (this version is fine for use at hackforla): This option would take just over 4GB.
  • a \u201cmore up to date\u201d option (not required but optional if you want it): This option prompts you to go to install an 8GB package manager called Homebrew.
  • Other option: If your computer is low on space, you can use this tutorial to install XCode Command Tools and a lighter version of Homebrew and then install Git using this command: $ brew install git which in total only uses 300MB.
"},{"location":"CONTRIBUTING/#215-install-docker","title":"2.1.5 Install Docker","text":"

Install or make sure docker and docker-compose are installed on your computer

    docker -v\n    docker-compose -v\n

The recommended installation method for your operating system can be found here. Feel free to reach out in the Hack for LA Slack channel if you have trouble installing docker on your system

More on using Docker and the concepts of containerization:

  • Get started with Docker
"},{"location":"CONTRIBUTING/#22-fork-the-repository","title":"2.2 Fork the repository","text":"

You can fork the hackforla/peopledepot repository by clicking Fork . A fork is a copy of the repository that will be placed on your GitHub account.

Note: It should create a URL that looks like the following -> https://github.com/<your_GitHub_user_name>/peopledepot.

For example -> https://github.com/octocat/peopledepot.

Be Aware: What you have created is a forked copy in a remote version on GitHub. It is not yet on your local machine yet.

"},{"location":"CONTRIBUTING/#221-clone-a-copy-on-your-computer","title":"2.2.1 Clone a copy on your computer","text":"

The following steps will clone (create) a local copy of the forked repository on your computer.

  1. Create a new folder in your computer that will contain hackforla projects.

In your command line interface (Terminal, Git Bash, Powershell), move to where you want your new folder to be placed and create a new folder in your computer that will contain hackforla projects. After that, navigate into the folder(directory) you just created.

For example:

cd /projects\nmkdir hackforla\ncd hackforla\n
  1. From the hackforla directory created in previous section:
git clone https://github.com/<your_GitHub_user_name>/peopledepot.git\n

For example if your GitHub username was octocat:

git clone https://github.com/octocat/peopledepot.git\n

**Note: You can also clone using ssh which is more secure but requires more setup. Because of the additional setup, cloning using https as shown above is recommended.

You should now have a new folder in your hackforla folder called peopledepot. Verify this by changing into the new directory:

cd peopledepot\n
"},{"location":"CONTRIBUTING/#222-verify-and-set-up-remote-references","title":"2.2.2 Verify and set up remote references","text":"

Verify that your local cloned repository is pointing to the correct origin URL (that is, the forked repo on your own GitHub account):

git remote -v\n

You should see fetch and push URLs with links to your forked repository under your account (i.e. https://github.com/<your_GitHub_user_name>/peopledepot.git). You are all set to make working changes to the website on your local machine.

However, we still need a way to keep our local repo up to date with the deployed website. To do so, you must add an upstream remote to incorporate changes made while you are working on your local repo. Run the following to add an upstream remote URL & update your local repo with recent changes to the hackforla version:

git remote add upstream https://github.com/hackforla/peopledepot.git\ngit fetch upstream\n

After adding the upstream remote, you should now see it if you again run git remote -v :

origin  https://github.com/<your_GitHub_user_name>/peopledepot.git (fetch)\norigin  https://github.com/<your_GitHub_user_name>/peopledepot.git (push)\nupstream        https://github.com/hackforla/peopledepot.git (fetch)\nupstream        https://github.com/hackforla/peopledepot.git (push)\n
"},{"location":"CONTRIBUTING/#23-build-and-run-using-docker-locally","title":"2.3 Build and run using Docker locally","text":"
  1. Start Docker Desktop
  2. Run docker container ls to verify Docker Desktop is running. If it is not running you will get the message: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
  3. Create an .env.dev file from .env.dev-sample
cp .env.dev-sample .env.dev\n
  1. Build and run the project via the script (this includes running docker-compose up)
./scripts/buildrun.sh\n
  1. Create a super user for logging into the web admin interface
docker-compose exec web python manage.py createsuperuser --no-input\n
  1. Browse to the web admin interface at http://localhost:8000/admin/ and confirm the admin site is running. Use DJANGO_SUPERUSER_USERNAME and DJANGO_SUPERUSER_PASSWORD from .env.dev for credentials.
"},{"location":"CONTRIBUTING/#3-managing-docker","title":"3. Managing Docker","text":""},{"location":"CONTRIBUTING/#31-stopping-docker","title":"3.1 Stopping Docker","text":"

To stop the service-container, but not destroy it (often sufficient for day-to-day work):

docker-compose stop\n

To stop and destroy the service container:

docker-compose down\n

Add the -v flag to destroy the data volumes as well:

docker-compose down -v\n
"},{"location":"CONTRIBUTING/#32-recycling-refreshing-database","title":"3.2 Recycling / Refreshing Database","text":"

To restore a database to its original state and remove any data manually added, delete the container and image. From Docker:

  1. Open Containers section
  2. Delete people-db-1 container
  3. Open Images Tab
  4. Remove djangorestapipostrgresql image
"},{"location":"CONTRIBUTING/#4-fixing-issues","title":"4. Fixing Issues","text":""},{"location":"CONTRIBUTING/#41-find-an-issue","title":"4.1 Find an issue","text":"

Find an issue in Prioritized Backlog here

If you joined the peopledepot repository as described in a previous section:

  1. Assign the issue to yourself and move it to \"In progress\" column.
  2. Follow the steps in the issue description to complete the issue.
  3. Make sure to comment your ETA and Availability when you first assign yourself.

If you don't have privileges, add a comment that you are working on the issue.

"},{"location":"CONTRIBUTING/#42-create-a-new-branch","title":"4.2 Create a new branch","text":"

Once you have selected an issue to work on, create a branch for that issue.

Verify you are on the main branch.

git branch\n

You will see a list of all of your branches. There will be a star (*) next to the branch that you are currently in. By default you should start on the main branch.

If you are not currently in the main branch, run the following command to return to it:

git checkout main\n
git pull origin main\n

This ensures you have the most recent code, which is important if you previously cloned and it has been more than a day.

Create a new branch where you will work on the issue. The branch name should include the issue number. For example, to create a new branch for issue 15 and change into it:

git checkout -b <new-branch-name>-15\n
"},{"location":"CONTRIBUTING/#43-make-changes","title":"4.3 Make changes","text":"

Make changes to fix the issue.

"},{"location":"CONTRIBUTING/#44-pull-to-get-the-most-recent-code","title":"4.4 Pull to get the most recent code","text":"

You can probably skip this if you fix the issue on the same day that you pulled the code.

git pull\n

Note: If you are using Visual studios code you can use the Git graphical user interface to stage your changes. For instructions check out the Git Gui Wiki.

"},{"location":"CONTRIBUTING/#45-add-changed-files-to-staging","title":"4.5 Add changed files to staging","text":"

Make sure you are on your issue branch (instead of main)

git branch\n

You must add your files to the staging area before you can commit (save them to git).

Run this command if you want to add changes from a specific file to your commit record:

git add \u201cfilename.ext\u201d\n

Run this command if you want to add all changes to all file(s) to your commit record:

git add .\n
"},{"location":"CONTRIBUTING/#46-check-git-status","title":"4.6 Check Git status","text":"

This command will list the files that have been staged with green text. These are the files that will be committed (saved) when you run the next command, git commit. Please be sure all your staged changes are relevant to the issue you are working on. If you accidentally included unrelated changes, please unstage them before making this commit, and then make a new commit for the unrelated changes. (The commands for unstaging commits are provided in the output of your git status command.)

git status\n
"},{"location":"CONTRIBUTING/#47-remove-files-that-you-dont-want-staged","title":"4.7 Remove files that you don't want staged","text":"

This command will unstage a file that you don't want included in the commit. The specified file will not be committed (saved) when you run the next command, git commit. This only works if the wrong files were added, but they were not yet committed. (See this tutorial for an in-depth discussion.) The file will be removed from the staging area, but not actually deleted:

git reset HEAD \u201cfilename.ext\u201d\n
"},{"location":"CONTRIBUTING/#48-run-pre-commit-checks","title":"4.8 Run pre-commit checks","text":"

Important: before committing each file, make sure to run the pre-commit script:*

./scripts/precommit-check.sh\n
"},{"location":"CONTRIBUTING/#49-commit-staged-changes","title":"4.9 Commit staged changes","text":"

This command saves your work, and prepares it to push to your repository. Use the -m flag to quickly add a message to your commit. Your message should be a short description of the changes you made. It will be extremely helpful if other people can understand your message, so try to resist the temptation to be overly cryptic.

To commit your changes with a message, run:

git commit -m \u201cinsert message here\u201d\n

Ensure that your local repository is up-to-date with the main site:

git pull upstream\n

You can also sync your fork directly on GitHub by clicking \"Sync Fork\" at the right of the screen and then clicking \"Update Branch\"

Click here to see how to sync the fork on GitHub"},{"location":"CONTRIBUTING/#410-push-to-upstream-origin-aka-your-fork","title":"4.10 Push to upstream origin (aka, your fork)","text":"

Push your local branch to your remote repository:

git push --set-upstream origin <your-branch-name>\n

Alternatively, you can run

git push\n
"},{"location":"CONTRIBUTING/#411-create-a-pull-request","title":"4.11 Create a pull request","text":""},{"location":"CONTRIBUTING/#4111-push-all-changes-in-your-issue-branch","title":"4.11.1 Push all changes in your issue branch","text":"

Once you are satisfied with your changes, push them to the feature branch you made within your remote repository.

git push --set-upstream origin <name-of-branch>\n
"},{"location":"CONTRIBUTING/#4112-complete-pull-request-from-github","title":"4.11.2 Complete pull request from GitHub","text":"
  1. Click the green button to create a Pull Request (PR)
  2. Add a short title in the subject line
  3. In the body of the comment, add the following, replacing <issue-number> with the issue you worked on:
fixes #<issue-number>\n
  1. Below this, add a brief description of the changes you made
  2. Click the green \"Create pull request\" button
  3. Add the PR to the project board
"},{"location":"CONTRIBUTING/#5-synch-main-changes","title":"5. Synch Main Changes","text":"

Your fork of this repository on GitHub, and your local clone of that fork, will get out of sync with the (upstream) repository as others update the repository. (That's what has happened when you see something like \"This branch is 1 commit behind peopledepot:main\" on your forked repository.)

One way to keep your fork up to date with this repository is to follow these instruction: Syncing your fork to the original repository via the browser

You can also update your fork via the local clone of your fork, using these instructions. Assuming you have a local clone with remotes upstream (this repo) and origin (your GitHub fork of this repo):

  • First, you will need to create a local branch which tracks upstream/main. You will only need to do this once; you do not need to do this every time you want to incorporate upstream changes.

Run the following two commands:

git fetch upstream\ngit checkout -b upstream-main --track upstream/main\n

If you have already created the branch upstream-main, the following commands will incorporate upstream changes:

git checkout upstream-main # Move to the branch you want to merge with.\ngit pull  # This updates your tracking branch to match the main branch in this repository\ngit checkout main  # Move back to your main branch\ngit merge upstream-main  # Merge to bring your main current.\n

If you do all your work on topic branches (as suggested above) and keep main free of local modifications, this merge should apply cleanly.

Then push the merge changes to your GitHub fork:

git push\n

If you go to your online GitHub repository this should remove the message \"This branch is x commit behind peopledepot:main\".

"},{"location":"CONTRIBUTING/#5-creating-issues","title":"5. Creating Issues","text":"

To create a new issue, please use the blank issue template (available when you click New Issue). If you want to create an issue for other projects to use, please create the issue in your own repository and send a slack message to one of your hack night hosts with the link.

"},{"location":"CONTRIBUTING/#appendix","title":"Appendix","text":""},{"location":"CONTRIBUTING/#a-submitting-bugs-for-third-party-packages-apps","title":"A. Submitting Bugs for Third Party Packages / Apps","text":"

You can go to these links and submit an issue:

  • Docker
  • Flake8
  • Black
  • isort
"},{"location":"LICENSE/","title":"LICENSE","text":"
                GNU GENERAL PUBLIC LICENSE\n                   Version 2, June 1991\n

Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

                        Preamble\n

The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) 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 this service 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. 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.

We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification follow.

                GNU GENERAL PUBLIC LICENSE\n

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  1. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The \"Program\", below, refers to any such program or work, and a \"work based on the Program\" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term \"modification\".) Each licensee is addressed as \"you\".

Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

  1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.

You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

  1. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

    a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

    b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

    c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

  1. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

    a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

    b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

    c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

  1. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

  2. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.

  3. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.

  4. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

  1. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

  2. The Free Software Foundation may publish revised and/or new versions of the 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 a version number of this License which applies to it and \"any later version\", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.

  1. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.

                        NO WARRANTY\n

  2. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.

  3. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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.

                 END OF TERMS AND CONDITIONS\n\n    How to Apply These Terms to Your New Programs\n

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 convey the exclusion of warranty; and each file should have at least the \"copyright\" line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.>\nCopyright (C) <year>  <name of author>\n\nThis program is free software; you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation; either version 2 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along\nwith this program; if not, write to the Free Software Foundation, Inc.,\n51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author\nGnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\nThis is free software, and you are welcome to redistribute it\nunder certain conditions; type `show c' for details.\n

The hypothetical commands show w' andshow c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than show w' andshow c'; they could even be mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your school, if any, to sign a \"copyright disclaimer\" for the program, if necessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.

, 1 April 1989 Ty Coon, President of Vice

This 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.

"},{"location":"architecture/Notes/","title":"Troubleshooting","text":""},{"location":"architecture/Notes/#modheader","title":"ModHeader","text":"
  • ModHeader will break Google drive if Authentication Bearer token is set. The Google drive website pops up a dialog saying:
\"You are not signed in.\nYou are signed out. Sign back in, then click 'Retry'.\nRetry\"\n

The solution is to disable the Authentication header and Google drive will work as normal.

"},{"location":"architecture/authentication/","title":"Cognito authentication","text":""},{"location":"architecture/authentication/#what-is-it","title":"What is it","text":"

Cognito is a single sign-on system from AWS. It allows multiple apps to accept authentication from the same set of user accounts. It separates the management of users and permissions from the applications that use them.

"},{"location":"architecture/authentication/#why-we-use-cognito","title":"Why we use cognito","text":"

We're invested in AWS, so we might as well use this too.

"},{"location":"architecture/authentication/#how-we-implement-it","title":"How we implement it","text":"

We're following the implementation from the djangostar tutorial.

These are the steps involved:

  1. Backend downloads JWKS from Cognito User Pool on launch
  2. User submits credentials and gets id_token and access_token
  3. User sends request with token
  4. Backend verifies token and processes request
  5. User gets response from authenticated API
"},{"location":"architecture/authentication/#current-dev-setup","title":"Current Dev Setup","text":"
  1. Created app client called \"backend within the vrms-dev user pool, with ALLOW_ADMIN_USER_PASSWORD_AUTH enabled
  2. \"Domain Name\" is already created at [https://hackforla-vrms-dev.auth.us-west-2.amazoncognito.com]
  3. In \"App client settings\", enabled Implicit grant and openid, Callback URL [http://localhost:8000/admin]
"},{"location":"architecture/authentication/#how-it-works-now-with-the-dev-user-pool-and-local-development-backend","title":"How it works now with the dev user pool and local development backend","text":"
  1. Create a cognito user and login from the Hosted UI (from App client settings). Successful login will redirect to localhost:8000/admin with the necessary tokens
  2. Take the access_token from the URL and make a GET request to http://localhost:8000/api/v1/me (Headers key=Authorization, value=Bearer )
  3. Backend should return the user's profile data
    4. "},{"location":"architecture/authentication/#notes","title":"Notes","text":"

    The tutorial is 2 years old now (from 2020) and there's been some change made since then.

    1. We created an app client in Cognito for the backend to interface with. ALLOW_ADMIN_USER_PASSWORD_AUTH is the new name for the old ADMIN_NO_SRP_AUTH setting. Reference
    2. In the custom User model step, the ugettext-lazy package is gettext-lazy for Django 4.0 Reference
    3. The tutorial steps don't include instructions to test each step, so it's a little bit of following blindly with the help of linters until the last step.
    "},{"location":"how-to/add-model-and-api-endpoints/","title":"Add new model and API endpoints","text":"

    This guide aims to enable developers with little or no django experience to add django models and API endpoints to the project. Most code examples are followed by detailed explanations.

    The developer will have exposure to the following in this document:

    • python
    • django
    • django rest framework
    • relational database through the Django ORM (object-relational mapper)
    • data types
    • object-oriented concepts (object, inheritance, composition)
    • unit testing
    • API design
    • command line

    This guide assumes the developer has followed the contributing doc and have forked and created a local branch to work on this. The development server would be already running in the background and will automatically apply the changes when we save the files.

    We will choose the recurring_event issue as an example. Our goal is to create a database table and an API that a client can use to work with the data. The work is split into 3 testable components: the model, the admin site, and the API

    Let's start!

    "},{"location":"how-to/add-model-and-api-endpoints/#the-model","title":"The model","text":""},{"location":"how-to/add-model-and-api-endpoints/#add-the-model-in-django","title":"Add the model in django","text":"

    Add the following to app/core/models.py

    class RecurringEvent(AbstractBaseModel):\n\"\"\"\n    Recurring Events\n    \"\"\"\nname = models.CharField(max_length=255)\nstart_time = models.TimeField(\"Start\", null=True, blank=True)\nduration_in_min = models.IntegerField(null=True, blank=True)\nvideo_conference_url = models.URLField(blank=True)\nadditional_info = models.TextField(blank=True)\nproject = models.ForeignKey(Project, on_delete=models.CASCADE)\n# location_id = models.ForeignKey(\"Location\", on_delete=models.DO_NOTHING)\n# event_type_id = models.ForeignKey(\"EventType\", on_delete=models.DO_NOTHING)\n# brigade_id = models.ForeignKey(\"Brigade\", on_delete=models.DO_NOTHING)\n# day_of_week = models.ForeignKey(\"DayOfWeek\", on_delete=models.DO_NOTHING)\n# must_roles = models.ManyToManyField(\"Role\")\n# should_roles = models.ManyToManyField(\"Role\")\n# could_roles = models.ManyToManyField(\"Role\")\n# frequency_id = models.ForeignKey(\"Frequency\", on_delete=models.DO_NOTHING)\ndef __str__(self):\nreturn f\"{self.name}\"\n

    link to code

    1. We inherit all models from AbstractBaseModel, which provides a uuid primary key, created_at, and updated_at timestamps. In the Github issue, these fields might be called id, created, and updated. There's no need to add those.
    2. Most fields should not be required. Text fields should be blank=True, data fields should be null=True.
    3. The data types in the github issue may be given in database column types such as INTEGER, VARCHAR, but we need to convert them into Django field types when defining the model.
    4. VARCHAR can be either CharField or TextField.
    5. CharField has a max_length, which makes it useful for finite length text data. We're going default to giving them max_length=255 unless there's a better value like max_length=2 for state abbreviation.
    6. TextField doesn't have a maximum length, which makes it ideal for large text fields such as description.
    7. Try to add the relationships to non-existent models, but comment them out. Another developer will complete them when they go to implement those models.
    8. Always override the __str__ function to output something more meaningful than the default. It lets us do a quick test of the model by calling str([model]). It's also useful for the admin site model list view.
    "},{"location":"how-to/add-model-and-api-endpoints/#run-migrations-to-generate-database-migration-files","title":"Run migrations to generate database migration files","text":"
    ./scripts/migrate.sh\n
    "},{"location":"how-to/add-model-and-api-endpoints/#write-a-simple-test","title":"Write a simple test","text":"

    Since we overrode the __str__ function, we need to write a test for it.

    1. Add a fixture for the model

    Fixtures are reusable code that can be used in multiple tests by declaring them as parameters of the test case. In this example, we show both defining a fixture (recurring_event) and using another fixture (project).

    Note: The conftest file is meant to hold shared test fixtures, among other things. The fixtures have directory scope.

    Add the following to app/core/tests/conftest.py

    @pytest.fixture\ndef recurring_event(project):\nreturn RecurringEvent.objects.create(name=\"Test Recurring Event\", project=project)\n

    link to code

    1. We name the fixture after the model name (recurring_event).
    2. This model makes use of the project model as a foreign key relation, so we pass in the project fixture, which creates a project model.

    3. We create an object of the new model, passing in at least the required fields. In this case, we passed in enough arguments to use the __str__ method in a test.

    4. Add a test case

    When creating Django models, there's no need to test the CRUD functionality since Django itself is well-tested and we can expect it to generate the correct CRUD functionality. Feel free to write some tests for practice. What really needs testing are any custom code that's not part of Django. Sometimes we need to override the default Django behavior and that should be tested.

    Here's a basic test to see that the model stores its name.

    Add the following to app/core/tests/test_models.py

    def test_recurring_event(recurring_event):\nassert str(recurring_event) == \"Test Recurring Event\"\n

    link to code

    1. Pass in our fixture so that the model object is created for us.
    2. The __str__ method should be tested since it's an override of the default Django method.

    3. Write assertion(s) to check that what's passed into the model is what it contains. The simplest thing to check is the __str__ method.

    4. Run the test script to show it passing

    ./scripts/test.sh\n
    "},{"location":"how-to/add-model-and-api-endpoints/#check-point-1","title":"Check point 1","text":"

    This is a good place to pause, check, and commit progress.

    1. Run pre-commit checks
    ./scripts/precommit-check.sh\n
    1. Add and commit changes
    git add -A\ngit commit -m \"feat: add model: recurring_event\"\n
    "},{"location":"how-to/add-model-and-api-endpoints/#the-admin-site","title":"The admin site","text":"

    Django comes with an admin site interface that allows admin users to view and change the data in the models. It's essentially a database viewer.

    "},{"location":"how-to/add-model-and-api-endpoints/#register-the-model-with-the-admin-site","title":"Register the model with the admin site","text":"
    1. Import the new model
    from .models import RecurringEvent\n

    link to code

    1. Register the model
    @admin.register(RecurringEvent)\nclass RecurringEventAdmin(admin.ModelAdmin):\nlist_display = (\n\"name\",\n\"start_time\",\n\"duration_in_min\",\n)\n

    link to code

    1. We declare a ModelAdmin class so we can customize the fields that we expose to the admin interface.
    2. We use the register decorator to register the class with the admin site.
    3. list_display controls what's shown in the list view
    4. list_filter adds filter controls to declared fields (useful, but not shown in this example).
    "},{"location":"how-to/add-model-and-api-endpoints/#view-the-admin-site-to-see-that-everythings-working-and-there-are-no-issues-which-should-be-the-case-unless-theres-custom-input-fields-creating-problems","title":"View the admin site to see that everything's working and there are no issues, which should be the case unless there's custom input fields creating problems","text":"

    1. See the contributing doc section on \"Build and run using Docker locally\" for how to view the admin interface.

    2. Example of a custom field (as opposed to the built-in ones)

    time_zone = TimeZoneField(blank=True, use_pytz=False, default=\"America/Los_Angeles\")\n

    link to code

    1. Having a misconfigured or buggy custom field could cause the admin site to crash and the developer will need to look at the debug message and resolve it.
    "},{"location":"how-to/add-model-and-api-endpoints/#tests","title":"Tests","text":"
    1. Feel free to write tests for the admin. There's no example for it yet.
    2. The reason there's no tests is that the admin site is independent of the API functionality, and we're mainly interested in the API part.
    3. When the time comes that we depend on the admin interface, we will need to have tests for the needed functionalities.
    "},{"location":"how-to/add-model-and-api-endpoints/#check-point-2","title":"Check point 2","text":"

    This is a good place to pause, check, and commit progress.

    1. Run pre-commit checks
    ./scripts/precommit-check.sh\n
    1. Add and commit changes
    git add -A\ngit commit -m \"feat: register admin: recurring_event\"\n
    "},{"location":"how-to/add-model-and-api-endpoints/#the-api","title":"The API","text":"

    There's several components to adding API endpoints: Model(already done), Serializer, View, and Router.

    "},{"location":"how-to/add-model-and-api-endpoints/#add-serializer","title":"Add serializer","text":"

    This is code that serializes objects into strings for the API endpoints, and deserializes strings into object when we receive data from the client.

    1. Import the new model
    from core.models import RecurringEvent\n

    link to code

    1. Add a serializer class
    class RecurringEventSerializer(serializers.ModelSerializer):\n\"\"\"Used to retrieve recurring_event info\"\"\"\nclass Meta:\nmodel = RecurringEvent\nfields = (\n\"uuid\",\n\"name\",\n\"start_time\",\n\"duration_in_min\",\n\"video_conference_url\",\n\"additional_info\",\n\"project\",\n)\nread_only_fields = (\n\"uuid\",\n\"created_at\",\n\"updated_at\",\n)\n

    link to code

    1. We inherit from ModelSerializer. It knows how to serialize/deserialize the Django built-in data fields so we don't have to write the code to do it.
    2. We do need to pass in the model, the fields we want to expose through the API, and any read_only_fields.

    3. uuid, created_at, and updated_at are managed by automations and are always read-only.

    4. Custom data fields may need extra code in the serializer

    time_zone = TimeZoneSerializerField(use_pytz=False)\n

    link to code

    1. This non-built-in model field provides a serializer so we just point to it.

    2. Custom validators if we need them

    We will need to write custom validators here if we want custom behavior, such as validating URL strings and limit them to the github user profile pattern using regular expression, for example.

    Example here when we have one\n
    "},{"location":"how-to/add-model-and-api-endpoints/#add-viewset","title":"Add viewset","text":"

    Viewset defines the set of API endpoints for the model.

    1. Import the serializer
    from .serializers import RecurringEventSerializer\n

    link to code

    1. Add the viewset and CRUD API endpoint descriptions
    @extend_schema_view(\nlist=extend_schema(description=\"Return a list of all the recurring events\"),\ncreate=extend_schema(description=\"Create a new recurring event\"),\nretrieve=extend_schema(description=\"Return the details of a recurring event\"),\ndestroy=extend_schema(description=\"Delete a recurring event\"),\nupdate=extend_schema(description=\"Update a recurring event\"),\npartial_update=extend_schema(description=\"Patch a recurring event\"),\n)\nclass RecurringEventViewSet(viewsets.ModelViewSet):\npermission_classes = [IsAuthenticated]\nqueryset = RecurringEvent.objects.all()\nserializer_class = RecurringEventSerializer\n

    link to code

    1. We inherit from ModelViewSet, which provides a default view implementation of all 6 CRUD actions: create, retrieve, partial_update, update, destroy, list.
    2. We use the extend_schema_view decorator to attach the API doc strings to the viewset. They are usually defined as docstrings of the corresponding function definitions inside the viewset. Since we use ModelViewSet, there's nowhere to put the docstrings but above the viewset.
    3. The minimum code we need with ModelViewSet are the queryset, and the serializer_class.
    4. Permissions
      1. For now use permission_classes = [IsAuthenticated]
      2. It doesn't control permissions the way we want, but we will fix it later.
    "},{"location":"how-to/add-model-and-api-endpoints/#extended-example","title":"Extended example","text":"

    This example shows how to add a filter params. It's done for the user model as a requirement from VRMS.

    1. Here's a more complex API doc example (this example is using the User model's ViewSet)
    @extend_schema_view(\nlist=extend_schema(\nsummary=\"Users List\",\ndescription=\"Return a list of all the existing users\",\nparameters=[\nOpenApiParameter(\nname=\"email\",\ntype=str,\ndescription=\"Filter by email address\",\nexamples=[\nOpenApiExample(\n\"Example 1\",\nsummary=\"Demo email\",\ndescription=\"get the demo user\",\nvalue=\"demo-email@email.com,\",\n),\n],\n),\nOpenApiParameter(\nname=\"username\",\ntype=OpenApiTypes.STR,\nlocation=OpenApiParameter.QUERY,\ndescription=\"Filter by username\",\nexamples=[\nOpenApiExample(\n\"Example 1\",\nsummary=\"Demo username\",\ndescription=\"get the demo user\",\nvalue=\"demo-user\",\n),\n],\n),\n],\n),\ncreate=extend_schema(description=\"Create a new user\"),\nretrieve=extend_schema(description=\"Return the given user\"),\ndestroy=extend_schema(description=\"Delete the given user\"),\nupdate=extend_schema(description=\"Update the given user\"),\npartial_update=extend_schema(description=\"Partially update the given user\"),\n)\nclass UserViewSet(viewsets.ModelViewSet):\n

    link to code

    1. Define strings for all 6 actions: create, retrieve, partial_update, update, destroy, list.

    2. This one is fancy and provides examples of data to pass into the query params. It's probably more than we need right now.

      1. The examples array can hold multiple examples.
        1. Example ID string has to be unique but is not displayed.
        2. summary string appears as an option in the dropdown.
        3. description is displayed in the example.

    3. Add any query params according to the requirements (this example is using the User model's ViewSet)

    class UserViewSet(viewsets.ModelViewSet):\n...\ndef get_queryset(self):\n\"\"\"\n        Optionally filter users by an 'email' and/or 'username' query paramerter in the URL\n        \"\"\"\nqueryset = get_user_model().objects.all()\nemail = self.request.query_params.get(\"email\")\nif email is not None:\nqueryset = queryset.filter(email=email)\nusername = self.request.query_params.get(\"username\")\nif username is not None:\nqueryset = queryset.filter(username=username)\nreturn queryset\n

    link to code

    1. Notice the queryset property is now the get_queryset(() function which returns the queryset.
    2. The get_queryset() function overrides the default and lets us filter the objects returned to the client if they pass in a query param.
    3. Start with all the model objects and filter them based on any available query params.
    "},{"location":"how-to/add-model-and-api-endpoints/#register-api-endpoints-to-the-router","title":"Register API endpoints to the router","text":"
    1. Import the viewset.
    from .views import RecurringEventViewSet\n

    link to code

    1. Register the viewset to the router
    router.register(r\"recurring-events\", RecurringEventViewSet, basename=\"recurring-event\")\n

    link to code

    1. First param is the URL prefix use in the API routes. It is, by convention, plural
      • This would show up in the URL like this: http://localhost/api/v1/recuring-events/ and http://localhost/api/v1/recuring-events/<uuid>
    2. Second param is the viewset class which defines the API actions
    3. basename is the name used for generating the endpoint names, such as [basename]-list, [basename]-detail, etc. It's in the singular form. This is automatically generated if the viewset definition contains a queryset attribute, but it's required if the viewset overrides that with the get_queryset function
      • reverse(\"recurring-event-list\") would return http://localhost/api/v1/recuring-events/
    "},{"location":"how-to/add-model-and-api-endpoints/#add-api-tests","title":"Add API tests","text":"

    For the CRUD operations, since we're using ModelViewSet where all the actions are provided by rest_framework and well-tested, it's not necessary to have test cases for them. But here's an example of one.

    1. Import API URL
    RECURRING_EVENTS_URL = reverse(\"recurring-event-list\")\n

    link to code

    1. Add test case
    def test_create_recurring_event(auth_client, project):\n\"\"\"Test that we can create a recurring event\"\"\"\npayload = {\n\"name\": \"Test Weekly team meeting\",\n\"start_time\": \"18:00:00\",\n\"duration_in_min\": 60,\n\"video_conference_url\": \"https://zoom.com/link\",\n\"additional_info\": \"Test description\",\n\"project\": project.uuid,\n}\nres = auth_client.post(RECURRING_EVENTS_URL, payload)\nassert res.status_code == status.HTTP_201_CREATED\nassert res.data[\"name\"] == payload[\"name\"]\n

    link to code

    1. Given
      1. Pass in the necessary fixtures
      2. Construct the payload
    2. When
      1. Create the object

    3. Then

      1. Check that it's created via status code
      2. Maybe also check the data. A real test should check all the data, but we're kind of relying on django to have already tested this.

    4. Run the test script to show it passing

    ./scripts/test.sh\n
    "},{"location":"how-to/add-model-and-api-endpoints/#check-point-3","title":"Check point 3","text":"

    This is a good place to pause, check, and commit progress.

    1. Run pre-commit checks
    ./scripts/precommit-check.sh\n
    1. Add and commit changes
    git add -A\ngit commit -m \"feat: add endpoints: recurring_event\"\n
    "},{"location":"how-to/add-model-and-api-endpoints/#push-the-code-and-start-a-pr","title":"Push the code and start a PR","text":"

    Refer to the contributing doc section on \"Push to upstream origin\" onward.

    "},{"location":"tools/mkdocs/","title":"MkDocs","text":""},{"location":"tools/mkdocs/#introduction","title":"Introduction","text":"

    We are using MkDocs to generate our documentation. See Docker-mkdocs repo for information about MkDocs and the image we're using.

    "},{"location":"tools/mkdocs/#mkdocs-docker-image","title":"MkDocs docker image","text":""},{"location":"tools/mkdocs/#how-it-works","title":"How it works","text":""},{"location":"tools/mkdocs/#work-on-docs-locally","title":"Work on docs locally","text":"

    1. It should already be running with the peopledepot django server. If not, run the mkdocs container.

      docker-compose up mkdocs # (1)!\n
      1. Optionally use the -d flag to run the container in the background

    2. Open a browser to http://localhost:8005/ to view the documentation locally.

    3. Modify the files in the docs directory. The site will auto-update when the files are saved.

    4. Quit

      Ctrl+C to quit the local server and stop the container

    "},{"location":"tools/mkdocs/#auto-generated-docs","title":"Auto-generated docs","text":"

    We have a GitHub Action set up to generate and host the documentation on a GitHub Pages site

    "},{"location":"tools/scripts/","title":"Convenience Scripts","text":"

    These are designed to make it easier to perform various everyday tasks in the project. They try to be transparent by exposing the underlying commands they execute so that users can have an idea of what's happening and try to learn the commands if they wish.

    These scripts assume you are using bash.

    1. buildrun.sh - clean, build, and run containers in background mode

      1. Pass in -v to remove data volume, which resets the local database.
      2. See the script file for more options.

    2. lint.sh - lint and and auto-format code

    3. test.sh - run tests and generate test coverage report

      1. Use the -k flag to filter tests. For example test.sh -k program_area will select only tests with \"program_area\" in the name. The coverage report will show many missing lines of coverage as a result. We recommend adding --no-cov in this case to disable the coverage report.

    4. logs.sh - view/tail container logs

    5. migrate.sh - run database migrations inside container

      1. Add <app> <migration_number> to migrate to that database state. Ex: migrate.sh core 0010

    6. precommit-check.sh - sanity checks before committing code

    7. createsuperuser.sh - creates a default superuser.

      1. This assumes that DJANGO_SUPERUSER_USERNAME and DJANGO_SUPERUSER_PASSWORD are set in .env.dev
    "},{"location":"tools/code-quality/pre-commit/","title":"Pre-commit","text":"

    The pre-commit hook in git will run before each commit and will abort the commit on failure. The advantage of this over GitHub Actions is that GitHub Actions work on code that's already committed, so it needs to allow code to be committed first.

    We're setting a set of fast checks to run on each commit and longer checks such as a full rebuild to run when trying to push the code.

    The hooks run when doing normal git commit and git push commands. It's recommended to do this in the command line. If performing these actions from a gui application, the interface may seem to hang for some time.

    Installing the pre-commit hooks to git

    1. Install pre-commit (virtual environment or at least per-user install is recommended)

      pip install pre-commit --local\n

    2. Add the hook to your local git repo

      cd $(git rev-parse --show-toplevel) # go to the repo's root dir\npre-commit install\n

    3. Update pre-commit and plugins to the latest version

      pre-commit autoupdate\n

    4. Test run the hooks (this runs it against all files rather than only staged files)

      pre-commit run --all-files\n

    5. (Extra info) More commands to test run the hooks

      pre-commit run --all-files --hook-stage push\npre-commit run --all-files --hook-stage commit\npre-commit run test --all-files --hook-stage push\n
    "}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 00000000..0f8724ef --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 00000000..fb369563 Binary files /dev/null and b/sitemap.xml.gz differ diff --git a/tools/code-quality/pre-commit/index.html b/tools/code-quality/pre-commit/index.html new file mode 100644 index 00000000..cac0b41e --- /dev/null +++ b/tools/code-quality/pre-commit/index.html @@ -0,0 +1,676 @@ + + + + + + + + + + + + + + + + + + + + + + Pre-commit - People Depot Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    + + + + + + + + + + + + +

    Pre-commit

    +

    The pre-commit hook in git will run before each commit and will abort the commit on failure. The advantage of this over GitHub Actions is that GitHub Actions work on code that's already committed, so it needs to allow code to be committed first.

    +

    We're setting a set of fast checks to run on each commit and longer checks such as a full rebuild to run when trying to push the code.

    +

    The hooks run when doing normal git commit and git push commands. It's recommended to do this in the command line. If performing these actions from a gui application, the interface may seem to hang for some time.

    +

    Installing the pre-commit hooks to git

    +
      +
    1. +

      Install pre-commit (virtual environment or at least per-user install is recommended)

      +
      pip install pre-commit --local
+
      +
      2. +
    2. +

      Add the hook to your local git repo

      +
      cd $(git rev-parse --show-toplevel) # go to the repo's root dir
+pre-commit install
+
      +
      3. +
    3. +

      Update pre-commit and plugins to the latest version

      +
      pre-commit autoupdate
+
      +
      4. +
    4. +

      Test run the hooks (this runs it against all files rather than only staged files)

      +
      pre-commit run --all-files
+
      +
      5. +
    5. +

      (Extra info) More commands to test run the hooks

      +
      pre-commit run --all-files --hook-stage push
+pre-commit run --all-files --hook-stage commit
+pre-commit run test --all-files --hook-stage push
+
      +
      6. +
    + + + + + + +
    +
    + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + \ No newline at end of file diff --git a/tools/mkdocs/index.html b/tools/mkdocs/index.html new file mode 100644 index 00000000..f0ca1919 --- /dev/null +++ b/tools/mkdocs/index.html @@ -0,0 +1,795 @@ + + + + + + + + + + + + + + + + + + + + + + MkDocs - People Depot Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    + + + + + + + + + + + + +

    MkDocs

    +

    Introduction

    +

    We are using MkDocs to generate our documentation. See Docker-mkdocs repo for information about MkDocs and the image we're using.

    +

    MkDocs docker image

    +

    How it works

    +

    Work on docs locally

    +
      +
    1. +

      It should already be running with the peopledepot django server. If not, run the mkdocs container.

      +
      docker-compose up mkdocs # (1)!
+
      +
        +
      1. Optionally use the -d flag to run the container in the background
        2. +
      +
      2. +
    2. +

      Open a browser to http://localhost:8005/ to view the documentation locally.

      +
      3. +
    3. +

      Modify the files in the docs directory. The site will auto-update when the files are saved.

      +
      4. +
    4. +

      Quit

      +

      Ctrl+C to quit the local server and stop the container

      +
      5. +
    +

    Auto-generated docs

    +

    We have a GitHub Action set up to generate and host the documentation on a GitHub Pages site

    + + + + + + +
    +
    + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + \ No newline at end of file diff --git a/tools/scripts/index.html b/tools/scripts/index.html new file mode 100644 index 00000000..e59a6d9c --- /dev/null +++ b/tools/scripts/index.html @@ -0,0 +1,678 @@ + + + + + + + + + + + + + + + + + + + + + + Convenience Scripts - People Depot Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    + + + + + + + + + + + + +

    Convenience Scripts

    +

    These are designed to make it easier to perform various everyday tasks in the project. They try to be transparent by exposing the underlying commands they execute so that users can have an idea of what's happening and try to learn the commands if they wish.

    +

    These scripts assume you are using bash.

    +
      +
    1. +

      buildrun.sh - clean, build, and run containers in background mode

      +
        +
      1. Pass in -v to remove data volume, which resets the local database.
        2. +
      2. See the script file for more options.
        3. +
      +
      2. +
    2. +

      lint.sh - lint and and auto-format code

      +
      3. +
    3. +

      test.sh - run tests and generate test coverage report

      +
        +
      1. Use the -k flag to filter tests. For example test.sh -k program_area will select only tests with "program_area" in the name. The coverage report will show many missing lines of coverage as a result. We recommend adding --no-cov in this case to disable the coverage report.
        2. +
      +
      4. +
    4. +

      logs.sh - view/tail container logs

      +
      5. +
    5. +

      migrate.sh - run database migrations inside container

      +
        +
      1. Add <app> <migration_number> to migrate to that database state. Ex: migrate.sh core 0010
        2. +
      +
      6. +
    6. +

      precommit-check.sh - sanity checks before committing code

      +
      7. +
    7. +

      createsuperuser.sh - creates a default superuser.

      +
        +
      1. This assumes that DJANGO_SUPERUSER_USERNAME and DJANGO_SUPERUSER_PASSWORD are set in .env.dev
        2. +
      +
      8. +
    + + + + + + +
    +
    + + +
    + +
    + + + +
    +
    +
    +
    + + + + + + + + + \ No newline at end of file