-
The development of this application was conducted on a Windows system. To ensure proper functionality, it is recommended to run the program on Windows. Testing on Mac systems has not been conducted.
-
The
.env.examplefile contains environment variables for database configuration. These should be modified to fit your local environment, including file paths and connection strings. -
For the OpenAI API, you will need to configure your API key as an environment variable on your computer. We use the Windows environment variable system to read the API key. The variable name is
OPENAI_API_KEY.
Please ensure the environment is properly set up before proceeding with the following steps!
-
Login Interface: Upon running the program, you will be presented with the user login interface. New users must register first before logging in. Usernames must be unique.
-
Homepage: After logging in, the homepage allows you to browse recommended restaurants. The homepage also lets you edit restaurants you wish to save and export them to notes. The top-right corner provides a button to switch to the saved notes page.
-
Notes Page: On the notes page, you can view your saved restaurants and click hyperlinks for more details. If you want to delete a restaurant, select the checkbox for that restaurant and click
Deleteto remove it.
New features are under development...