The purpose of this repository is to help you get started with the basic tools ๐จ and code ๐ป needed to follow along in the workshop. It will also serve as the single source of truth, hosting the latest version of our facemask ๐ท detector workshop material ๐.
We hope that you will find great joy and meaning in our workshop! ๐ Consider giving this repository a star โญ if you found it helpful!
This guide covers the installation of:
- Anaconda - a distribution of python which comes with a lot of data science packages ๐ฆ.
jupyter notebook
- a live python execution environment typically used for exploratory ๐ data analysis.nodejs
andnpm
- nodejs is a js (javascript) runtime built on chrome's V8 engine ๐ and npm is a package manager for nodejs.
You may find the detailed installation instructions for your operating system (Linux/Mac/Windows) via the links below. We know the instructions might look pretty lengthy but it won't take more than 20 minutes! ๐๐๐
If you use a Windows machine, click here.
If you use a Mac, click here.
If you use Linux, click here.
Please only follow ONE of the installation guides e.g. if you're using Mac please don't follow the Linux guide by accident. We can't help you with troubleshooting issues otherwise.
Please post a Github issue on this repo if you encounter any difficulties!
Follow the instructions below to get familiarized with the project repository. You may make reference to this section during the workshop itself to perform certain tasks ๐.
Note that the backend code is incomplete - you'll be filling in the blanks during the workshop!
- Open up terminal (wsl terminal for Windows) and type
sudo apt update && sudo apt upgrade
. This ensures you have the latest system packages. - Run
git clone --depth 1 https://github.com/geoboom/facemask-workshop.git
to clone this repo. If you get agit command not found
error, runsudo apt install git
first then try cloning the repo again. - Run
ls
and you should see a folder calledfacemask-workshop
.
- In terminal, type
cd facemask-workshop
to navigate to the project's root folder. - In the root folder, navigate to the notebook subdirectory by typing
cd notebook
. - Type
conda activate base
to activate Anaconda's base environment. You should see(base)
beside your name in terminal. - Now run
jupyter notebook
and this notebook folder should open in Jupyter Notebook on your browser.
- Open up a new terminal and type
cd facemask-workshop
to navigate to the project's root folder. - In the root folder, navigate to the frontend subdirectory by typing
cd frontend
. - Type
npm install
to install the frontend project dependencies. This might take a while so grab a coffee โ. - Once the dependencies have finished installing, type
npm run dev
to run the website's server (nextjs
). - Visit
localhost:3000
in your browser to see the website live!
- Open up a new terminal and type
cd facemask-workshop
to navigate to the project's root folder. - In the root folder, navigate to the backend subdirectory by typing
cd backend
. - Type
python3 -m venv venv
to create apython3
virtual environment in the backend directory. - Type
source venv/bin/activate
to activate this virtual environment. You should see(venv)
beside your name, indicating that thevenv
environment is activated. - Run
pip install -r requirements.txt
to install the dependencies to this virtual environment. This might take a while so grab a coffee โ. - Once dependencies have finished installing, type
./run.sh
to run the FastAPI server and hit enter.
This section is under construction.
Name | Role | Github |
---|---|---|
Jet | NUS Statistics Society Workshop Director | https://github.com/jetnew |
Rama | Presenter, guide writing, and material prep | https://github.com/ramav111 |
Georgie | Presenter, guide writing, and material prep | https://github.com/geoboom |
Dataset for masked/no-masked.