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.
- 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.
Before you begin, ensure you have the following dependencies installed:
-
Clone the repository:
git clone https://github.com/your-username/ecoview-api.git
-
Navigate to the project directory:
cd ecoview-api -
Set up environment variables:
Create a
.envfile in the project root and configure the following:PORT=3000 MONGODB_URI=mongodb://mongo:27017/ecoview SECRET_KEY=your-secret-key
Adjust the values as needed for your environment.
-
Build and run the Docker containers:
docker-compose up -d
This command will build the Docker images and start the containers in detached mode.
-
The API server will be running at
http://localhost:3000.
To use the Ecoview API, refer to the API documentation for detailed information on available endpoints and request/response formats.
Detailed API documentation is available here.
We welcome contributions! If you'd like to contribute to Ecoview API, please follow our contribution guidelines.