Local Installation¶
This is how to install a local copy of Krypted, which is primarily used by developers. Do not use this method in production unless you’re familar with making Django applications production ready.
Clone the Repository¶
Clone the GitHub repository to your local file system.
git clone https://github.com/KryptedGaming/krypted.git
Run the installation script¶
- Navigate to the directory
cd krypted - Ensure permissions are correct
chmod +x ./install/install.sh launcher - Create a virtual environment
./launcher env - Enter your virtual environment
source ./myenv/bin/activate - Run the installation script
./launcher install - Verify your installation
./launcher test
Recommended: VSCode¶
We recommend you use VSCode when developing, because it’s awesome.
- Install VSCode from this link
- Get the
Pythonextension for VSCode - Get the
py-coverage-viewextension for VSCode (for code coverage when running./launcher test)
Recommended: Juniper Notebooks¶
By default, the developer requirements installs shell plus and notebook.
- Enable
django-extensionsin yourINSTALLED_APPS - Start notebook with
python3 manage.py shell_plus --notebook - Create a notebook, start developing
By utilizing this tool, you’ll be able to refresh your code changes and re-run previous code. It’s a lifesaver for Python development, especially when debugging.