PursuitPioneer - Hack United

This repository contains a project developed for the Hack United hackathon as a New Year's Resolution initiative. The project utilizes React for the front end, and Go along with MySQL for the back end.

Features

Client Folder Components

• React Router and React Query: The project incorporates React Router for navigation and React Query to simplify the fetching and management of data from the backend.

• Tailwind CSS: Styling of components is achieved through Tailwind CSS. It's worth noting that Tailwind is not directly installed but is instead used as a CDN provided by Tailwind CSS.

• React-custom-roulette: The spinning wheels feature is implemented using the React-custom-roulette package.

• Randomcolor Package: To generate random colors for the spinning wheels, the project utilizes the Randomcolor package.

Web Application Functionality

The web application requires users to register/login. Once authenticated, users can choose a subject they would like to improve for their New Year's resolution. The application leverages the GPT API to generate challenges related to the chosen subject. These challenges are designed to assist users in achieving their New Year's resolutions.

How to Use

To run the project locally, follow these steps:

1. Clone the repository to your local machine.
2. Create a .env file in the be-app directory with the following environment variables:

   GPT_API_KEY=<your_gpt_api_key>
   

3. Navigate to the client folder and install the dependencies using npm install.
4. Start the development server with npm start.
5. Explore the application at http://localhost:3000.

How to Use with Docker

To run the application using Docker and Docker Compose, follow these steps:

1. Clone the repository to your local machine.

2. Create a .env file in the be-app directory with the following environment variables:

   GPT_API_KEY=<your_gpt_api_key>
   

3. Navigate back into the root directory

4. Run docker-compose up --build

5. To turn it off run docker-compose down

6. Explore the application on http://localhost:3000.

Contributors

This project was developed by the team at Hack United for the New Year's Resolution theme. Hack United v2.

Acknowledgments

Special thanks to the creators of React, Go, and the various npm packages that contributed to the functionality and aesthetics of this project.

Feel free to contribute, report issues, or suggest enhancements to make PursuitPioneer even better!