Send Your Christmas Wish to Santa
Mail Santa is a fun and interactive application where children can write letters to Santa Claus, view their wish history, and track the status of their wishes. The app allows children to create an account, submit their wishes, and revisit their past letters and responses from Santa.
- Backend: Ruby on Rails 7
- Database: PostgreSQL
- Templating engine: HAML
- Authentication: Devise
- AI integration: OpenAI API
- Testing: RSpec, VCR
To get a local copy up and running follow these simple example steps.
$ cd <folder>
$ git clone [email protected]:PolinaStamenova/mail-santa.git
$ cd mail-santa
$ bundle install
$ rails db:migrate
rspec spec
- Children can navigate to the dashboard and write their letter to Santa for the current year.
- Children can view their past wishes from previous years in the Wish History section.
You can view the API documentation for Mail Santa at the following URL:
To view the API documentation locally, make sure the app is running and navigate to /api-docs in your browser.
For detailed INSTRUCTIONS on API TESTING and HOW to USE the Mail Santa API, check out the API Documentation.
The app integrates with OpenAI GPT-4 API to process children's letters and extract present details. When a child submits a letter, the OpenAI service extracts the present details like name, color, and size for the Present creation.
Setup instructions:
-
Add your OpenAI API key to the credentials.yml.enc file.
-
Use the following structure:
openai: api_key: YOUR_OPENAI_API_KEY
👤 Polina Stamenova
- GitHub: @githubhandle
- LinkedIn: LinkedIn
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!