Fruitify

A simple Angular application for searching and visualizing fruit nutrition information.
Report a Bug

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

This application allows users to search for fruits by name, order, family, or genus, and learn more about their nutritional values.

Fruit images are sourced from two online photo services: Unsplash and Pexels.

The project includes a Node.js backup server providing mocked APIs for the application. (The original online API was discontinued during development.) However, the server is not the core focus of this project.

Built With

This section lists the primary frameworks and tools used to build the project. Plugins and additional tools are mentioned in the acknowledgements. Key technologies include:

• Angular
• Angular Material
• NgRx
• TailwindCSS

Getting Started

Follow these instructions to set up the project locally.

Prerequisites

This project requires Node.js (v19 or higher) and a package manager. While the examples below use NPM, you may use any package manager you prefer.

Installation

Note

If you just want to try the application in prduction-like mode, jump directly to the production-like mode section.

1. Obtain free API keys at:

   • Unsplash
   • Pexels

2. Clone the repository:

   git clone https://github.com/mancarius/fruitify2.git

3. Install API server dependencies:

   cd api
   npm install

4. Create a .env file in the API directory and add your API keys:

   NODE_ENV=development
   PEXELS_API_KEY=<la-tua-pexels-api-key>
   UNSPLASH_API_KEY=<la-tua-unsplash-api-key>

5. Install client dependencies:

   cd ../client
   npm install

Development mode

To run the application in development mode:

1. Start the API server:

   cd /api
   npm run start:dev

2. Start the client:

   cd ../client
   npm run dev

Access the application at http://localhost:4200

Production-Like mode

Important

You must have a container management tool (e.g., Docker or Podman) installed on your machine to run this command.

Run the application in production mode using Docker:

docker-compose -f docker-compose.prod.yml up -d --build

Access the application at http://localhost

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Mattia Mancarella - LinkedIn - hello@mattiamancarella.com

Project Link: https://github.com/mancarius/fruitify2

Acknowledgements

• Font Awesome
• NestJS
• Docker
• Unsplash
• Pexels