Skip to content

RGBOARD/webapp

Repository files navigation

Running the Backend

To run app.py:

  1. Create a virtual environment:

    python -m venv env
  2. Activate the virtual environment:

    Windows users (powershell):

    .\env\Scripts\activate

    If it gives an error due to scripts being disabled, open Powershell as admin and run this command first:

    Set-ExecutionPolicy RemoteSigned

    If using Linux/Mac:

    source env\bin\activate
  3. Make sure you have java installed:

    If using Linux:

    sudo apt-get install default-jre
    which java

    If using Mac/brew:

    brew install java

    If using Windows: Download and install Java from Oracle's website

  4. Install python libraries inside the created virtual environment

    pip install -r requirements.txt
  5. If you are on vscode, remember to set the python interpreter to the created environment's python version.

  6. After python env is ready, database must be created in the root folder (/backend):

    python utilities/create.py 
  7. Run the server (in its own terminal):

    python app.py

Running the Web App (Frontend)

  1. Navigate to the frontend directory (in its own terminal):

    cd view
  2. Install dependencies:

    npm install
  3. Run the development server:

    npm run dev

After Sign Up and Log in

  1. Without credentials file: Open your database application and check the VerificationCode table to find the code associated with the newly created account.

  2. With credentials file: You should receive an email containing the verification code.

Fetching PRs

  1. Fetch the PR and create a local branch on your device. For example, PR #15:

    git fetch origin pull/15/head:pr-15
  2. Switch to the PR branch.

    git checkout pr-15
  3. To refresh a PR branch with the latest changes:

    git pull origin pull/15/head

Releases

No releases published

Packages

No packages published

Contributors 5