Skip to content

readme updated for WSL in window set up - #106

Open
MImran2002 wants to merge 1 commit into
developmentfrom
updateReadME
Open

readme updated for WSL in window set up#106
MImran2002 wants to merge 1 commit into
developmentfrom
updateReadME

Conversation

@MImran2002

@MImran2002 MImran2002 commented Aug 20, 2026

Copy link
Copy Markdown

Description

This PR updates the BCSR README to replace the outdated Cloud9 development setup instructions with a current Windows development workflow using WSL and Ubuntu.

The updated documentation now includes instructions for:

  • Checking for and installing WSL and Ubuntu
  • Installing and verifying MySQL and MySQL Workbench
  • Running the project inside the WSL Linux environment
  • Activating the existing virtual environment using setup.sh
  • Resolving CRLF/LF issues that can prevent setup.sh from running correctly
  • Creating the required data directory
  • Adding the existing database configuration to app/config.yaml
  • Running create_db.py to initialize the development database
  • Viewing the development database
  • Running the Flask application with python3 app.py
  • Updating the requirements and project structure sections to reflect the current development environment

This PR is documentation-only and does not change the existing application code or database implementation.

###Testing

To test this PR, the reviewer should follow the updated README setup instructions from beginning to end on a Windows development environment.

The reviewer should verify that the documented steps successfully lead to the BCSR development application running locally.

Some minor deviations may be necessary depending on the reviewer's existing Windows, WSL, Ubuntu, Python, or MySQL setup, but the overall setup process should remain accurate and usable.

Comment thread README.md
If you don't see Ubuntu installed run: ```wsl --install -d Ubuntu```, then restart your laptop afterwards.

![creatework.PNG](https://bitbucket.org/repo/bEXb4L/images/4213557604-creatework.PNG)
Then launch Ubuntu with: ```wsl``` then in a Ubuntu terminal you can run ```uname -a``` it will run Linux system info.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since I was using a Mac, I did not need to do some steps, like setting up the Linux environment, for example. So I was thinking it might be helpful to specify the steps for people using a Mac, so they don't try to copy the steps for Windows.

Comment thread README.md
**Step Two: Activate Your Virtual Environment**

After you have created your workspace, there are three additional steps that you will have to complete before your virtual environment will be completely operational.
In order to do this, first you need to be in Ubuntu so run in your terminal: ```wsl```.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would specify to clone the repository [ git clone https://github.com/BCStudentSoftwareDevTeam/bcsr.git] or else you would get the error message " No such file or directory". Then also make sure they are in the correct directory by using "cd bcsr".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants