If you’re ready to take your culinary skills to the next level, Foodfy is here to assist you in managing your favorite recipes, exploring new ones, and discovering amazing chefs. In this article, you’ll learn how to install and set up Foodfy on your machine efficiently.

Table of Contents

• Features
• Installation
• Getting Started
• FAQ
• Found a bug? Missing a specific feature?
• Contributing
• License

🚀 Features

• Explore recipes and find amazing chefs.
• Create an account to manage recipes, chefs, and users.
• Admin privileges to invite other users.
• Multi-language support (English and Portuguese).
• Cool dark mode theme toggle.

Note: The admin platform isn’t fully translated yet.

🔧 Installation

Before installing Foodfy, make sure you have Node.js and Yarn installed on your system. Once you have that covered, follow these steps:

git clone https://github.com/LauraBeatris/foodfy.git

If you prefer using SSH (requires an SSH key registered in your GitHub), use:

git clone git@github.com:LauraBeatris/foodfy.git

Once cloned, install the dependencies:

yarn install

Next, create your environment variables:

cp .env.example .env

Make sure to fill the variables with the appropriate values.

🏃‍♂️ Getting Started

Running with Docker-Compose

To prepare the database and run the application using Docker, set your environment variables and execute:

docker-compose up

The application will be accessible at the port specified in your environment’s PORT variable.

Manual Setup

If you prefer a manual setup, install Postgres and create a database or start a Postgres container if using Docker:

docker-compose up postgres

Next, create the tables and relationships:

yarn db:create

To populate your database with initial data, run:

yarn run:seeds

Finally, start the application in development mode:

yarn dev

📬 FAQ

Question: What technologies are used in this project?

Answer: The project utilizes NodeJS with the Express Framework for the server, Nunjucks for templating, and SCSS for styles.

Question: How is multi-language support handled?

Answer: This is managed with the i18n-node library, which sets visitor language preferences using cookies and JSON translation files for different locales.

Question: Can all users create and update chefs or recipes?

Answer: No, there are two types of users: Visitors and Administrators. Only Administrators have the ability to create and manage chefs and recipes, although Visitors can access the administrative platform.

🐛 Found a bug? Missing a specific feature?

If you encounter issues, feel free to file a new issue in the Foodfy repository. If you have a solution, we welcome pull requests! Check out the contribution guidelines for more information.

🎉 Contributing

Interested in contributing? Visit the contributing page to learn about opportunities for collaboration.

📚 License

This project is released under the MIT license. Developed with love by Laura Beatris.

Troubleshooting

If you face issues during installation or setup, consider the following troubleshooting tips:

• Ensure that you have Node.js and Yarn installed correctly.
• Verify that the environment variables are filled out with valid data.
• If using Docker, ensure that Docker is running prior to executing commands.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.