Fauxmazon is a fake store API built with the Phoenix framework in Elixir. It provides a simple and scalable solution for managing products and serving them via a RESTful API. Please note that this project is currently in development. Fauxmazon simulates the functionality of an e-commerce platform, allowing users to interact with a catalog of products via HTTP endpoints. It provides basic operations for retrieving product information, searching for products, and filtering products by category.

Products in the Fauxmazon API have the following properties:

{
  "id": 1,
  "name": "Organic Skin Care Kit",
  "description": "A collection of three organic skin care products in one kit.",
  "brand": "Erbology",
  "price": "49.99",
  "rating": "4.50",
  "stock": 100,
  "categories": [
    {
      "id": 1,
      "name": "Health & Beauty",
      "description": "Discover a wide range of products for your health and beauty needs.",
      "inserted_at": "2024-04-22T17:34:22Z",
      "updated_at": "2024-04-26T16:29:46Z"
    }
  ],
  "images": [
    "https://via.placeholder.com/500x500?text=Product+Image+1",
    "https://via.placeholder.com/500x500?text=Product+Image+2"
  ]
}

The following entry points are available in the Fauxmazon API:

1. Get All Products:
   [GET] http://localhost:4000/products

2. Get Product by ID:
   [GET] http://localhost:4000/products/:id

3. Search By Name:
   [GET] http://localhost:4000/products/search?name={name}

4. Category By Id + Respective Products:
   [GET] http://localhost:4000/categories/:category

5. Get All Categories:
   [GET] http://localhost:4000/categories/ These entry points allow users to retrieve product information, search for products, and filter products by category. Additional functionality may be added in future updates.

To get started with Fauxmazon, follow these steps:

1. Clone the repository: git clone https://github.com/Sierra9999/fauxmazon.git
2. Install dependencies: mix deps.get
3. Start the Phoenix server: mix phx.server

Contributions are welcome! If you'd like to contribute to Fauxmazon, please fork the repository and submit a pull request with your changes.

This project is licensed under the MIT License - see the LICENSE file for details.