1. Working on the Website

csss-site

• 1. Setup Python Environment
• 2. Setup and Run Website
• 3. Before opening a PR
• Various tasks to accomplish

1. Setup Python Environment

for Debian based OS

sudo apt-get install -y python3.9
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3.7 get-pip.py --user
python3.7 -m pip install virtualenv --user
python3.7 -m virtualenv envCSSS
. envCSSS/bin/activate

for MacOS

https://www.python.org/downloads/release/python-3913/

python3.9 -m pip install --upgrade pip
python3.9 -m pip install virtualenv
python3.9 -m virtualenv envCSSS
. envCSSS/bin/activate

for Windows

open to anyone to make a PR adding this section

2. Setup and Run Website

If you hve not cloned your forked version yet
wget https://raw.githubusercontent.com/CSSS/csss-site/master/download_repo.sh
./download_repo.sh

If you have forked your version
./run_site.py

3. Before opening a PR

Please submit PRs one week before they need to be merged.

3.1. Validating the code

3.1.1 Validating Python Code

../../CI/validate_and_deploy/1_validate/run_local_formatting_test.sh

3.1.2 Validating the HTML Code

docker run -it --rm --name validator --net="host"  --add-host=csss.website:127.0.0.1 -p 8888:8888 ghcr.io/validator/validator:23.4.11

and the you can bring up the validator locally using http://0.0.0.0:8888/ and use csss.website:8000 instead of 127.0.0.1:8000 or localhost:8000 when accessing the Django app within the validator docker container

Various tasks to accomplish

Link to wiki for adding a webpage