Welcome to Treasure Hunt, a web application that allows users to play a treasure hunt game and manage their game data using a backoffice. The game involves finding hidden interest points using QR codes, and each user can collect points on map.
To get started with the project, follow these steps:
- Clone the repository to your local machine.
- Install Docker and Docker Compose if you haven't already done so.
- Copy env.example to .env
- Run
docker-compose upto start the Postgres container. - Run
yarnto install the dependencies. - Run
yarn db:push && yarn db:seedto update schema database and seed database - Run
yarn devto start the development server.
This project uses the following technologies:
- Remix - A framework for building web applications.
- Prisma - A modern database toolkit for working with databases.
- Chakra UI - A UI library for React applications.
- Docker Compose - A tool for defining and running multi-container Docker applications.
- PostgreSQL - A powerful, open-source relational database management system.
Treasure Hunt offers the following features:
- A treasure hunt game that involves finding hidden interest points using QR codes.
- A backoffice that allows users to manage their game data, including their collected points and leaderboard ranking.
- A user authentication system that requires users to sign up and log in before playing the game or accessing the backoffice.
If you'd like to contribute to Treasure Hunt, please follow these steps:
- Fork the repository.
- Create a new branch for your changes.
- Make your changes and commit them.
- Push your changes to your fork.
- Submit a pull request.
Build with Love ❤ by :