Bookish-Octo-Invention

Bookish-Octo-Invention is a web application designed for recipe sharing tailored to specific dietary needs. Whether you’re looking for gluten-free, vegan, or low-carb options, this platform makes it easy to find and share recipes that suit your dietary preferences.

1. Features

• Personalized Recipe Recommendations: Get recipe suggestions based on your dietary restrictions and preferences.
• User-Generated Content: Share your own recipes and discover those shared by others.
• Search & Filter: Easily search for recipes using advanced filters like ingredients, dietary type, and meal category.
• Nutritional Information: Access detailed nutritional data for each recipe.

2. Getting Started

2.1 System Requirements

Ensure your system meets the following requirements:

• A compatible web browser (e.g., Chrome, Firefox, Safari).
• An active internet connection.
• Node.js and npm installed on your system.

2.2 Installation

1. Clone the repository:

   git clone https://github.com/kvnbbg/bookish-octo-invention.git
   cd bookish-octo-invention

2. Install dependencies:

   npm install

3. Configuration:

   • Environment Variables: Set up environment variables by creating a .env file in the root directory:

     cp .env.example .env

     Fill in the .env file with your configuration settings (e.g., session secrets, API keys).

   • Session Management: Configure session management and ensure your SESSION_SECRET is secure.

4. Run the Application:

   npm start

   The application will typically run on http://localhost:3000. Visit this URL in your web browser to access the application.

3. Logging In

Access the application:

1. Open your web browser.
2. Visit the application by navigating to http://localhost:3000.
3. Sign in using your credentials, or explore the application as a guest.

Note: The application is deployed using either Back4App or Netlify for now. The final decision is pending. For production deployment, further instructions will be provided.

4. Deployment

Deploying the Application:

• Deploy on Netlify (Static files):

  • Connect your GitHub repository to Netlify.
  • Set the build command to npm run build and the publish directory to build/.

• Deploy on Back4App (For Docker containers):

  • Follow Back4App’s documentation to deploy your Node.js application in a container.

Alternative Deployment Options:

• Heroku:

  • Deploy your Node.js app on Heroku by connecting your GitHub repo and setting up the necessary environment variables.

• Vercel:

  • Easily deploy with Vercel by linking your GitHub repository and following their Node.js deployment steps.

5. Contributing

We welcome contributions! To contribute:

1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Submit a pull request to the main branch.

Please read our Contribution Guidelines for more details.

6. License

This project is licensed under the MIT License.

7. Expanded Documentation

For more detailed information, refer to the following documents:

• User Manual
• Technical Documentation
• Design Assets Document

---

Author: Kevin Marville
Contact: code@kvnbbg.fr