Skip to content

How to develop with Windows

Leila Moran edited this page Nov 4, 2021 · 1 revision

How to develop with Windows

Setup

Follow these steps to make life easier.

1. Clone the repository

git clone https://github.com/CSC510-Group-25/feature-hunt.git

Alternatively, you can clone your own fork, or clone the repository from your IDE.

2. Use an IDE

You can choose whichever IDE works best for you, but bear in mind that this guide was made with Visual Studio Code as a reference.

You will need the following extensions:

VSCode Python
Pylance
Prettier not necessary since there is a 'yarn lint' command that runs it, but it can make things easier if you're in a hurry.

Once you have your IDE set up, use it to open feature-hunt.

3. Set up a virtual environment

Using your IDE, open up a terminal. Use Git Bash or Power Shell to make life easier, though Git Bash is the better option.

Ensure that the current directory is feature-hunt!

Install virtualenv if you don't have it already: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/

Then run the following command:

python -m venv .venv 

to create a virtual environment.

If you're having issues: Flask installation

Then, open up the command palette (ctrl + shift + p, or under View tab) and select 'Python: select interpreter.'

Once you have your environment set up, open up a new Git Bash and move to the next step.

4. Install dependencies

npm install

Installs the dependencies for the React App

pip install -r backend/requirements.txt

Installs the requirements for the Flask API

5. Launch!

Follow the guide on the README to launch your project.