Paw Share is a compassionate application committed to aiding animals and their caregivers during difficult times. Our app connects individuals facing the challenge of caring for their pets or encountering animals in distress with appropriate solutions to ensure the well-being of these cherished creatures.
We stand firmly against the promotion of animal breeding for profit and instead advocate for responsible adoption and support for animals in distress. At Paw Share, our mission is to foster a culture of empathy and assistance towards animals in need.
Moreover, Paw Share facilitates temporary pet care, enabling pet owners to entrust their beloved companions to the care of others during their absences or times of incapacity. Our primary focus is not financial gain, but rather, it is on cultivating and strengthening the bonds shared by passionate animal lovers like you.
If you don't have or want to use Docker, you will need to have:
- A mysql database running locally or remotely on port 3306 (be sure to update the credientials in the
.envfile)
-
Clone the repo
-
Run the setup script (use the correct script for your OS)
chmod +x ./scripts/setup-project.sh && ./scripts/setup-project.sh./scripts/setup-project.bat- Create a
.envfile in the following directories:
/packages/api/packages/app/packages/web
And follow the .env.example file in each directory to fill in the required environment variables.
- Run the project (use the correct script for your OS)
chmod +x ./scripts/start-project.sh && ./scripts/start-project.shIf you get an error saying that a command was not found, edit the start-project.sh file and add your current terminal to the list of terminals (line 3).
local terminals=("x-terminal-emulator" "gnome-terminal" "konsole" "YourTerminal")To find out the name of your terminal, run the following command:
ps -p $(ps -p $$ -o ppid=) -o comm=chmod +x ./scripts/macos-start-project.sh && ./scripts/macos-start-project.sh./scripts/start-project.bat-
Clone the repo
-
Install NPM packages
cd packages/api
npm install
cd ../app
npm install
cd ../web
npm install- Create a
.envfile in the following directories:
/packages/api/packages/app/packages/web
And follow the .env.example file in each directory to fill in the required environment variables.
- Start the database
cd packages/api
npm run db- Start the API
cd packages/api
npm run dev- Start the app
cd packages/app
npm start- Start the web client
cd packages/web
npm run dev