README.md

User Handler

This service will communicate with the data layer for user registration and login. Since it is required to validate the access token for almost all of the requests from users, using the database for saving and validating the token is not very efficient. Therefore, a persistent key-value store in this service is storing the access token.

Service Requirements

This service is using the linkstorm_datalayer service. Therefore, you need to run the linkstorm_datalayer service before running this service.

Managing the Environment and Dependencies

First install virtualenv with pip.

pip install virtualenv

Then create an empty virtual environment.

virtualenv .venv

Note that .venv is the name of the virtual environment directory, this directory is omitted in the .gitignore file.

After creating the virtual environment, activate it.

UNIX based Operating Systems (GNU/Linux, macOS, etc.)

source .venv/bin/activate

Windows

.\venv\Scripts\activate

Now you can install the required python packages in the clean environment you just created.

pip install -r requirements.txt

Running the Service

After installing the dependencies, you can go to the app directory and then run the service by executing the following command.

python main.py

If you want to change the port number, you can do so by changing the PORT constant in the settings.py file.

Further Questions?

Feel free to create an issue or contact us directly.