Potty Pals is a toilet finding web app. It has a number of features that can be easily accessed from a UI to generate a list of toilets in a particular location. The app displays the 'Potty Pal' logo, as a pins on a map with easy to read pop-ups offering information about specific toilets, including facilities, pricing and ratings.
- Login/Sign-Up
- Add toilet
- Review Toilet
- Add toilet image
- View Toilets
- Map Pin with geolocation
You have to make sure that mongodb, npm and node have been installed in your local machine before running the project. If not, follow the steps below.
-
npm
npm install npm@latest -g npm -v
-
nvm & node
# visit https://github.com/nvm-sh/nvm on how to install nvm nvm install node node -v -
mongodb
brew tap mongodb/brew brew install [email protected] brew services start [email protected]
To run tests, run the following commands
cd backend
npm run test cd frontend
npm run testClone the project
git clone https://github.com/AmberG31/Potty-palGo to the backend directory
cd backendInstall dependencies
npm installGo to the frontend directory
cd frontendInstall dependencies
npm installStart the server
npm run startThis project was built with the following tools:
