This project is a photo tagging app/game inspired by the "Where's Waldo?" books series.
The app consists of a game with multiple levels where the User has to find characters in a photo as quickly as possible.
The user time is then stored and a leaderboard for each level is provided in the app.
- NPM
- PostgreSQL database
-
Fork the Project repository
-
Clone the forked repository to your local machine
git clone [email protected]:<your username>/<repo name>.git -
Update remote URL
# SSH: git remote add upstream [email protected]:where-is-waldo/<repo name>.git # HTTPS: git remote add upstream https://github.com/where-is-waldo/<repo name>.git -
Go to the server directory
cd server -
Create a .env file in the project root directory with the following keys
PORT=<PORT> DATABASE_URL=<your_db_url> -
Install required packages
npm install -
Go to the client directory and repeat the same process, this time with this key
VITE_API_URL=<your_api_url> -
Open the app in development mode
npm run dev
If an error occurs, make sure you have done everything properly according to this guide. If you think so, you can Open an Issue.
Once the app, the API and the db are running, you should be able to start the app locally.
Game rules can be found in the app's homepage.
If you find an issue within the app or want to contribute, you can Open an Issue.
Noa Houssier - Github