https://github.com/r3tr056/ecolens_api
Ecoview: Scan, Choose, Thrive. Elevate your environmental consciousness with our app, offering insights into product sustainability. Make responsible choices, discover green alternatives, and contribute to a greener future with every scan.
https://github.com/r3tr056/ecolens_api
api-rest fiber-framework gcp golang jwt microservice postgres redis
Last synced: 3 months ago
JSON representation
Ecoview: Scan, Choose, Thrive. Elevate your environmental consciousness with our app, offering insights into product sustainability. Make responsible choices, discover green alternatives, and contribute to a greener future with every scan.
- Host: GitHub
- URL: https://github.com/r3tr056/ecolens_api
- Owner: r3tr056
- Created: 2024-01-04T10:55:25.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-28T22:26:20.000Z (about 1 year ago)
- Last Synced: 2025-01-14T06:53:22.992Z (4 months ago)
- Topics: api-rest, fiber-framework, gcp, golang, jwt, microservice, postgres, redis
- Language: Go
- Homepage: https://ecoview.live
- Size: 328 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Ecoview API
## Scan, Discover, Choose: EcoView - Your Path to Sustainable Living
Ecoview API is the backend application that powers EcoView, an innovative application designed to enhance environmental awareness and promote sustainability. EcoView enables users to scan and search for products, providing valuable insights into each item's environmental impact. The application encourages responsible consumption and offers green alternatives, contributing to a more eco-conscious and sustainable lifestyle.
## Table of Contents
- [Introduction](#ecoview-api)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Product Scanning:** Users can scan product barcodes to retrieve detailed environmental information.
- **Search Functionality:** Search for products to get insights into their environmental impact.
- **Environmental Ratings:** Products are rated based on their sustainability, helping users make informed choices.
- **Green Alternatives:** EcoView suggests eco-friendly alternatives to promote sustainable consumption.
- **User Accounts:** Users can create accounts to save favorite products and track their eco-friendly choices.
- **Admin Panel:** Administrative tools for managing products, categories, and user data.
## Installation
### Prerequisites
Before you begin, ensure you have the following dependencies installed:
- [Docker](https://www.docker.com/get-started)
### Docker Installation
1. Clone the repository:
```bash
git clone https://github.com/your-username/ecoview-api.git
```
2. Navigate to the project directory:
```bash
cd ecoview-api
```
3. Set up environment variables:
Create a `.env` file in the project root and configure the following:
```env
PORT=3000
MONGODB_URI=mongodb://mongo:27017/ecoview
SECRET_KEY=your-secret-key
```
Adjust the values as needed for your environment.
4. Build and run the Docker containers:
```bash
docker-compose up -d
```
This command will build the Docker images and start the containers in detached mode.
5. The API server will be running at `http://localhost:3000`.
## Usage
To use the Ecoview API, refer to the API documentation for detailed information on available endpoints and request/response formats.
## API Documentation
Detailed API documentation is available [here](link/to/api/documentation).
## Contributing
We welcome contributions! If you'd like to contribute to Ecoview API, please follow our [contribution guidelines](link/to/contributing.md).