Virtual Tech School

Virtual Tech School is a community aiming to help everyone get started, learn and grow together in our fast paced industry. By everyone, we mean EVERYONE!

This is a repository for our community's website. Following are the steps for running it locally in your system -

1. Creating a Virtual Environment

After cloning the repository, navigate into the repository through command line terminal / command prompt and create a virtual environment with the following command -

python -m venv venv

We have used Python3.11.x for this application. You can check the version of python in your system by running -

python --version

Note - Python 3 might be accessible in some devices with python3 command, therefore your command to create the virtual environment becomes - python3 -m venv venv

Note - Sometimes, you may get an error while trying to create a virtual environment, returning a non-zero exit status 1. In that case, checkout the solution here. After this, the above command should run as intended.

2. Sourcing the Virtual Environment

Once the virtual environment is created, source it with -

source venv/bin/activate

Note - The above command will work in Linux and MacOS, but for windows, try the below command -

venv\Scripts\activate.bat

3. Sourcing Environment Variables

For MacOS/Linux - Create a file called dev.env and add the following inside that file -

export FLASK_DEBUG=true
export SERVICE_URL=http://localhost:5000

export CHANNEL_ID={YouTube Channel ID}
export YT_API_KEY={Your Google API Key}
export YOUTUBE_LINK={YouTube Channel Link}

export DISCORD_SERVER_ID={Discord Server ID}
export DISCORD_LINK={Discord Server's Invite Link}

export TWITTER_TOKEN={Your Twitter Bearer Token}
export TWT_USERNAME={Twitter Handle Username}
export TWITTER_LINK={Twitter Profile Link}

export HASHNODE_PROFILE={Hashnode Profile Page}
export HASHNODE_LINK={Hashnode Blog Link}

Source the above file with - source dev.env

Note - If you do not wish to generate the API Keys and Tokens, edit the app/views/views.py and replace get_*_stat() function with hardcoded numbers.

For Windows - Create a file called dev.bat and add the same contents as above in the file. Source it with - dev.bat

4. Installing Libraries and Dependencies

For installing dependencies and libraries, run -

pip install -r requirements.txt

5. Starting the server

To start the server, run -

python manage.py run

The website should now be hosted on http://localhost:5000. Feel free to contribute in our website, or let us know if you have any improvements in mind on our discord server.

abdulrahmonbb / virtual-tech-school Goto Github PK