SafeEats

SafeEats is an app that helps users determine if a food product meets their dietary preferences, including vegan, vegetarian, halal, and kosher standards.

Setup and Installation

Clone the Repository:

git clone https://github.com/CodeX-y/safe-eats.git
cd safe-eats

Install Dependencies:
```
bundle install
npm install
```

Set Up the Database:

rails db:create
rails db:migrate
rails db:seed

Run the Application:
```
bin/dev
```
Access the Application: Open your browser and navigate to http://localhost:3000.

Configuration

There are currently no configurations needed.

Contribution

We welcome contributions to the SafeEats project! To ensure a smooth contribution process, please follow these guidelines:

Coding Conventions

Follow the Ruby style guide and adhere to RuboCop rules.
Write clear and descriptive commit messages.
Ensure your code is well-documented and includes tests where applicable.

Branch Naming Conventions

Use the format feature/your-feature, bugfix/your-bugfix, or hotfix/your-hotfix.
- For example: feature/user-authentication, bugfix/fix-login-error.

Pull Request Process

Fork the Repository:
- Fork the repository on GitHub by clicking the "Fork" button at the top right of the page.

Create a New Branch:

Clone your forked repository and create a new branch for your changes:

git clone https://github.com/your-username/safe-eats.git
cd safe-eats
git checkout -b feature/your-feature

Make Changes and Commit:
- Make your changes and commit them with a descriptive message:
```
git add .
git commit -m "Add feature to handle user authentication"
```
Push Changes:
- Push your branch to your forked repository:
```
git push origin feature/your-feature
```
Open a Pull Request:
- Navigate to the repository on GitHub and open a pull request from your branch to main or develop.
- Provide a clear description of the changes in the pull request.
Review and Merge:
- Review comments and address any feedback.
- Once approved, your pull request will be merged into the main repository.

Thank you for contributing to SafeEats!

ERD

FAQ

1. How can I contribute to SafeEats?

Please refer to the Contribution section for detailed guidelines on how to contribute, including coding conventions, branch naming, and the pull request process.

2. How do I report a bug or request a feature?

Report a Bug: Open an issue on the GitHub repository with detailed information about the bug.
Request a Feature: Open an issue on GitHub describing the feature you'd like to see.

3. How can I get help with issues?

For help with issues:

Check the Issues section on GitHub for similar problems.
If you don’t find a solution, open a new issue with details about your problem.

4. What technologies are used in SafeEats?

SafeEats uses Ruby on Rails for the backend and Bootstrap and CSS for frontend styling. It also incorporates libraries for user authentication and data processing.

5. How can I contact the maintainer?

You can reach the maintainer, CodeX-y, by opening an issue on the GitHub repository.

6. Is SafeEats ready for production use?

SafeEats is primarily designed for development and testing. The goal is to develop the app for production use in the near future. Please review the code, perform comprehensive testing, and configure appropriate production settings so we can reach that goal.

If you have any additional questions, feel free to reach out or open an issue!

Visual Aids

First Page

Second Page

Results

heratyian/SafeEats