Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/satyamvyas04/ecotrader
EcoTrader.io | Updated Website
https://github.com/satyamvyas04/ecotrader
freelance mongodb nextjs tailwindcss
Last synced: 4 days ago
JSON representation
EcoTrader.io | Updated Website
- Host: GitHub
- URL: https://github.com/satyamvyas04/ecotrader
- Owner: SatyamVyas04
- Created: 2024-11-28T12:01:36.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-19T12:28:01.000Z (23 days ago)
- Last Synced: 2025-01-19T12:29:56.380Z (23 days ago)
- Topics: freelance, mongodb, nextjs, tailwindcss
- Language: TypeScript
- Homepage: https://ecotrader.io
- Size: 6.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**EcoTrader** is a platform that empowers small investors to participate in the renewable energy market, allowing investments in solar, wind, hydrogen, and waste-to-energy projects. The platform aims to provide users with opportunities to earn passive income while contributing to climate change mitigation. [Visit EcoTrader](https://www.ecotrader.io/)
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
## Features
- **User Authentication**: Secure login and registration system.
- **Investment Dashboard**: Real-time insights into investment portfolios.
- **Project Exploration**: Browse and invest in various renewable energy projects.
- **Responsive Design**: Optimized for various devices and screen sizes.
- **Animations**: Smooth transitions and animations for enhanced user experience.
## Technologies Used
- **Framework**: [Next.js](https://nextjs.org/)
- **Language**: [TypeScript](https://www.typescriptlang.org/)
- **Styling**: [Tailwind CSS](https://tailwindcss.com/)
- **Animations**: [React AOS](https://www.npmjs.com/package/react-aos)
- **UI Components**: Custom components with "magic" UI effects
## Installation
To set up the project locally, follow these steps:
1. **Clone the Repository**
```bash
git clone https://github.com/SatyamVyas04/ecotrader.git
```
2. **Navigate to the Project Directory**
```bash
cd ecotrader
```
3. **Install Dependencies**
```bash
npm install
```
This command will install all required project dependencies specified in `package.json`.
4. **Configure Environment Variables**
Create a `.env` file in the root directory and add your MongoDB connection string:
```env
MONGODB_URI=mongodb+srv://:@cluster.mongodb.net/ecotrader?retryWrites=true&w=majority
```
Replace `` and `` with your MongoDB credentials.
5. **Build the Project**
```bash
npm run build
```
This command compiles the project and prepares it for deployment or local running.
## Usage
After completing the installation steps, you can start the development server:
```bash
npm run dev
```
Open your browser and navigate to `http://localhost:3000` to explore the application.
## Contributing
Contributions are welcome! Please follow these steps:
1. Fork the repository.
2. Create a new branch (`feature-branch`).
3. Commit your changes.
4. Push to your fork and submit a pull request.
This project is licensed under the MIT License. See the `LICENSE` file for details.