JewishPositivity

Contributors

• Jessica Yasi
• Jacob Pacheco
• Molly Nelson
• Dan Cox
• Lorelie Murphy
• Zach Fisher
• Roman Galeano
• Alex Gallant
• Diego Gonzalez-Tellez
• Jaheim Law
• Caitlin Nolan
• Nick Samios
• Tiziana Hernandez
• Brian Farrell
• Ryan Barry

Getting Setup

Clone this repository to your local machine.

git clone https://github.com/HillCapstone2024/JewishPositivity.git

Install VS Code

Add the following extensions:

• Prettier
• Django
• Pylance
• GitLens
• Git Graph
• GitHub Actions
• SonarLint
• SonarCloud

Download Python 3.12.2

Download NodeJS 20.11.0

Make sure your pip and npm installers are up to date

python -m pip install --upgrade pip
npm install npm@latest -g

For Mac, if you get an error involving permissions after this npm command or after npm install, try npm install -g npm@latest --unsafe-perm=true --allow-root. If you encounter an error with pip or python not being recognized, try python3 and pip3 instead. To change your path to use Python and pip instead follow these steps:

• In the bash terminal, run: nano ~/.bash_profile

• Add the below lines to the file that opens:

  alias python='python3'
  alias pip='pip3'

• Close the file with ctrl+X and then press Y to save the changes and press enter to return to the terminal

• Run the command source ~/.bash_profile to update the terminal or just open a new one

install Django and other pip packages

pip install -r requirements.txt

install NodeJs packages

cd React_Native
npm install

IP.js for Frontend

To get the front end to work, you need to add a file called 'ip.js' that includes your IP Address. Contact the development team for how to properly configure this. download the Expo Go app on your phone (iOS, Android) For working with the database, install MySQL Workbench.

Running the Project

Backend

cd JP_Django
python manage.py runserver 0.0.0.0:8000

Env File for Backend

You need to add a .env file with the credentials and your IP Address to get the backend to work. Contact the development team for how to set this up.

Adding Unit tests to the Pipeline

For any Python unit tests, be sure to add them to the Django folder so they can be properly accessed by the pipeline files. Then to add the tests to the suite, open the django.yml file found in /.github/workflows. Within this file, scroll to the bottom of the page where you can find a section named Run Tests`.

Underneath there is a run section with a default Python test called manage.py. Copy the same syntax as that for your tests and be sure to commit and push your tests to the repository before adding them with the same indentation as the previous tests. For example, python mytest.py test would run perfectly fine on the pipeline.

After the test is added, saving the file, committing, and pushing will ensure the test will run on the pipeline whenever the code is pushed to the repository.

If you have any pipeline questions, send the tools team a message on Slack and they can try and fix any issues you may be having.

After starting the Django server, if you encounter this error: You have 18 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, content types, sessions., you should run python manage.py migrate to apply them.

MAC Installing mysqlclient: Follow this guide With the lib= step,

• make sure you add the path given by which mysql_config to the line: vi path
• To find the line, type /libs to find the place in the document
• Press I to enter insert mode, copy and paste what the guide tells you to, and comment out the line it says to replace. (try sudo if necessary)
• Exit with escape, then`:wq!

If it still doesn't work, follow these steps as well:

• Get the path for the config file with mysql_config --cflags`
• Type this command: export MYSQLCLIENT_CFLAGS= "path from above"
• Same thing for library: mysql_config --libs export MYSQLCLIENT_LDFLAGS= "path from above" Try these commands as well
• export CFLAGS="-D__x86_64__"
• export ARCHFLAGS="-arch x86_64" Re-try pip install mysqlclient

Frontend

cd React_Native
npx expo start

A QR code will appear in the terminal, scan the QR code to run the app on your phone in Expo Go. If you're having issues with loading the app on Expo Go, try running the next expo start`` --tunnel instead. This should help on restricted networks like Hillspot. The first time you run the line, it may ask to install @expo/ngrok@^4.1.0 - make sure to accept the global installation of this package.

If tunneling prevents your app from working, you can try the following: 'px expo start --reset-cache' or disable the firewall and antivirus software.

Running Frontend Jest Tests

CD into the React_Native folder then run 'npm test'. All frontend tests should be located in the test directory inside of React_Native

cd React_Native
npm test