Skip to content

README.md

Latest commit

 

History

History
73 lines (50 loc) · 1.66 KB

README.md

File metadata and controls

73 lines (50 loc) · 1.66 KB

Lexicard

A website that generates flashcards by providing documents.

Contributors

Agosto, Fredierick @Poemeu

Apas, John Clyde @Glitch-1010

Caracena, Geralyn @alyn13

Cellan, Kate Aubrey @DaijobuDes

Genegabuas, Seejee @densentsu124

Setup

  1. Install python. Stable version 3.8.9 and Git.

  2. Clone this repository by opening a command prompt/terminal.

$ git clone https://github.com/DaijobuDes/flashcard
  1. Creation of the virtual environment.
$ cd flashcard
$ py -m venv .
  1. Activate the virtual environment.

On Windows Powershell:

PS> Set-ExecutionPolicy Unrestricted
PS> Scripts\activate

On Windows Command Prompt:

> Scripts\activate.bat

On Linux/Mac: (Make sure you have python3-pip installed)

$ source bin/activate
  1. Install requirements
$ pip3 install -r requirements.txt
  1. Run the server
$ py ./manage.py runserver

Deploying the server

Install nginx on linux.

$ sudo apt install nginx

Inside configuration folder, configure flashcard.conf, change fields to where you need to place them.

Add SSL server certificates in order to enable HTTPS mode. (HTTP mode, plain/text data exchange is NOT recommended.)

For the run_server file, edit both --user and --group to your desired username and execute chmod +x ./configuration/run_server while being in the root of the project.

Run with ./configuration/run_server.