Giovanni-Schroevers / pkm-card-maker-back

Pokemon card maker Back-end

As per conventions, commands to run in the terminal are prefixed with $. This symbol should not be typed.

Setup

This setup assumes that you have python 3.7 and pip installed. A virtual environment will be used to install dependencies.

• Install pipenv with $ pip install pipenv
• Clone the project
• navigate to the project $ cd pkm-card-maker-back
• run $ pipenv install --ignore-pipfile this creates a new virtual environment and installs the dependencies as specified in the pipenv.lock file.
• Open the virtual environment with $ pipenv shell
• Create a database named pkm
• Copy the .env.example and rename it to .env
• Inside the .env, edit the incorrect variables to match yours
• Migrate the database
  • Run $ python manage.py migrate
• Run the server
  • Run $ python manage.py runserver

Troubleshooting

If you get the error ModuleNotFoundError: No module named 'MySQLClient' while running the server, you need to install the mysqlclient.
Make sure you are running a 64 bit version of python

If it does not work try to:

• Download the client for python version 'cp37' here (64bit) or here (32 and 64 bit)
• Install the client by running `pip install

Pipenv

Pipenv is a tool to create and manage virtual environments and install dependencies and track their versions (including versions of sub-dependencies). It is very similar to NPM in the way that it creates a Pipfile.lock and it allows install packages as dev dependencies.

To install a package use $ pipenv install <package name>. To install a dev dependency add the --dev flag. Find more info on Pipenv on the Pipenv project site. It is strongly recommended to read this documentation and familiarize yourself with how pipenv versioncontrol works.