retky/cooktheweek-ror

[Server] Meal planning and cooking for users. Allows to make recipes, schedule meals for the week, and generate shopping lists for the ingredient of the chosen days.

CookTheWeek-RoR (Server)

Server component of a comprehensive Recipe App. Empowering users to create, organize, and plan their meals, the API facilitates the seamless creation of recipes with detailed ingredient lists. Users can conveniently schedule their weekly or monthly meals, and the system intelligently generates shopping lists based on the selected days. With CookTheWeek-RoR, meal planning becomes a breeze, ensuring a well-prepared and organized approach to culinary delight.

🛠️ Build with

🔗 API Documentation

Coming Soon

🚀 Getting Started

To get a local copy up and running follow these simple steps.

📋 Prerequisites

Ensure you have the following installed on your machine:

• Git
• PostgreSQL
• Ruby

⚙️ Setup

1. Clone this repository:

git clone https://github.com/retky/CookTheWeek-RoR.git

2. Associate your Database:

If required update the config/database.yml file (lines 25 & 26) with your PostgreSQL database credentials.

💽 Install

1. Install project dependencies using Bundler:

bundle install

2. Create the Database, Tables and Values:

rails db:create db:migrate: db:seed

🖱️ Usage

1. Run the Development Server:

rails server

2. Visit http://localhost:3000 in your web browser to access the application.

🧪 Run tests

Execute RSpec for testing:

rspec

📦 Deployment

Note: If required include your documentation using Swagger.

👤 Author

J. Luis Arredondo (Retky)

• GitHub: @Retky
• Twitter: @RetkyFox
• LinkedIn: Retky

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to get in touch with any issues or suggestions.

• 🐛 Bug reports & issues: Use GitHub Issues
• 💡 Suggestions: Use Github Discussions
• 🙋‍♀️ General questions: Use Github Discussions

✨ Show your support

Give a ⭐️ if you like this project!

📝 License

Copyright © 2023, J. Luis Arredondo. See LICENSE for details.