Development Guide

Windows Development

This page contains instructions for setting up the Penn Clubs development environment for Windows. For best results, ensure that you are using Windows 10.

Installation

First, follow the instructions on the README. Read the instructions below and the troubleshooting section before starting that guide.

This repository contains several symlinks. If you are using Windows, you will need to perform additional steps to ensure they are properly reproduced in your development environment. No action is necessary for MacOS and Linux. You may have to enable symlinks globally by editing your git config file, or enable symlinks only for this repo by cloning with the -c core.symlinks=true flag, like so:

git clone -c core.symlinks=true [email protected]:pennlabs/penn-clubs.git

Editing

We recommend using VSCode as the preferred IDE when developing on Windows. There is a penn-clubs.code-workspace file that you can open to setup your development environment. Open this file by going to File > Open Workspace... and selecting this code workspace file.

When you open the workspace for the first time, it will prompt you to install recommended extensions. Be sure to accept this prompt. This will install Python and Javascript code formatting tools that conform to the Penn Clubs code style guide.

Task Shortcuts

You can start the frontend and backend server using VSCode tasks. Simply go to Terminal > Run Task > Run Penn Clubs to start up the frontend and backend server. Note that this will not install the required dependencies for you, you must first get the server running the normal way (with terminals) before using this feature. After you have successfully run both servers once, you can use this method in the future.

Troubleshooting

• It is normal to see uwsgi fail to install when running pipenv install on Windows. This package is only compatible with MacOS and Linux. pipenv will attempt to install all other packages anyways, so this will not affect anything.
• If the rich text editor is broken on the club edit page, you most likely have incorrectly configured your repository symbolic links. See this post for details on how to fix this. When the text editor is working, it is supposed to look something like this: