LineUp offers a streamlined and user-friendly solution to the common challenges of managing skincare routines. This innovative platform enables users to effortlessly create and manage their personalized skincare routines with simplicity and precision. By providing an option to generate a step-by-step guide, LineUp ensures that users apply their products in the optimal order, enhancing the effectiveness of their skincare regimen. Additionally, LineUp integrates the powerful capabilities of OpenAI's API, making it easy for users to discover and tailor their own personal lineup based on intelligent recommendations and real-time advice. This integration not only simplifies the process of routine creation but also enriches the user experience by adapting to individual skincare needs and preferences.
Users are able to search through existing products in the catalog to get further information about each one. Users are also able to submit and send in products that they love that they want to see in the database.
Users are able to title their own routines and select specific products they want placed into it.
Users are able to easily click "generate routine" on the specific routine, and in return, OpenAI's API will generate the line up of what order they should use each of the products in.
- Ruby version:
3.2.1 - Rails version:
7.0.4.3 - Tailwind CSS Rails
2.4 - Bootstrap
5.3.3
appdev_supportannotateawesome_printbetter_errorsbinding_of_callerdotenv-railsdraft_generatorsdraft_matchersdevisefakergrade_runnerhtmlbeautifierhttppry_railsrails_dbrails-erdrspec-html-matchersrspec-railsrufospecs_to_readmetable_printweb_gitwebmocksimple_formpunditcsvkaminariransackrails_adminsassc-railssprocket_rails
To configure your application to use the ChatGPT's OpenAI API, follow these detailed steps:
If you do not already have a master.key file, you can generate one by running:
EDITOR="code --wait" rails credentials:editThis command will open the credentials file in Visual Studio Code (replace "code --wait" with your preferred editor, nano is also another tool), and a new master.key file will be generated automatically if it does not exist.
Inside the opened credentials file, add your API tokens and other sensitive configuration variables in a structured format. For example:
open_ai_api_key: YOUR_OPENAI_API_ACCESS_KEYSave and close the file. The changes will be encrypted and saved securely, accessible only via the master.key.
If you would like to periodically check your key for reference you can run the command below and it should appear in your terminal.
rails credentials:showNever commit your master.key or the credentials file to version control. Add the master.key to your .gitignore file to prevent it from being accidentally pushed to your repository:
echo 'config/master.key' >> .gitignore- Clone the repository and switch to the main branch
- Run the following commands
bundle install
rails db:migrate
rails slurp:reset
rails slurp:type_of_products
rails slurp:products
rails slurp:ingredients
rake sample_data
bin/devAfter running the above commands you will have generated all the data needed to see the app functioning. The user Alice will have access, you can sign in with:
- Email:
[email protected] - Password:
password
Or make your own personal account by signing up!
Thank you for your interest in contributing to LineUp. This document provides guidelines and instructions on how to contribute to the project.
- Setup your environment: Follow the installation instructions above.
- Find an issue to work on: In the Projects tab, check out our issues, we continue to add new issues frequently so feel free to create your own issues as well.
We adhere to the Ruby community style guide, and we expect all contributors to follow suit. Here are key conventions specific to our project:
-
Code Style: Follow the Ruby Style Guide, which provides detailed guidelines on the coding style preferred by the Ruby community.
-
Naming Conventions:
- Use
snake_casefor variables, methods, and file names. - Use
PascalCasefor class and module names. - Reflect domain concepts accurately in naming. For instance, if you are working within a financial application, prefer names like
user_account_detailsover vague terms likedata.
- Use
-
Design Principles: Focus on Domain-Driven Design (DDD):
- Organize code to reflect the domain model clearly.
- Use service objects, decorators, and other design patterns that help isolate domain logic from application logic.
- Comment your code where necessary to explain "why" something is done, not "what" is done—source code should be self-explanatory regarding the "what".
- Document methods and classes thoroughly, focusing on their roles within the domain model, especially for public APIs.
- Commit messages should be clear and follow best practices, such as those outlined in How to Write a Git Commit Message.
- Keep commits focused on a single issue to simplify future maintenance and troubleshooting.
Please use the following naming conventions for your branches:
<initals-issue#-description>(i.e mcw-31-added-pagination)
- Creating a Pull Request: Provide a detailed PR description, referencing the issue it addresses.
- Review Process: PRs require review from at least one maintainer.
Join our Discord to communicate with other contributors and maintainers.
Thank you for contributing to LineUP!
- Be sure to follow the Configuration Instructions if you encounter an issue when setting up the project.
- For help with how to use the ChatGPT's OpenAI API, see the documentation here.
- The project is written using Ruby 3.2.1, if you encounter issues upon cloning, make sure you have Ruby version 3.2.1 in your environment, also see the Ruby Language docs.