This project is a web application built using FastAPI for the backend and Next.js for the frontend. It includes features such as Kafka consumer integration and email sending functionality.
- Python 3.8+
- Node.js 14+
- Kafka (for event consumption)
-
Clone the repository:
git clone <repository-url> cd <repository-directory>
-
Install Poetry:
curl -sSL https://install.python-poetry.org | python3 - -
Install the required Python packages:
poetry install
-
Set up environment variables: Create a
.envfile in the root directory and add your environment variables. -
Run the backend server:
poetry run uvicorn app.main:app --reload
-
Navigate to the frontend directory:
cd frontend -
Install the required Node.js packages:
npm install
-
Run the frontend development server:
npm run dev
- Implement user authentication
- Add unit tests for components
- Improve UI/UX design
- Integrate with backend API
- Ensure Kafka is running and properly configured.
- Start the backend server as described in the installation section.
- Start the frontend server as described in the installation section.
- Access the application at
http://localhost:3000.
The backend includes a Kafka consumer that listens for events and processes them accordingly. Ensure Kafka is running and the consumer is properly configured in your environment variables.
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin feature/your-feature). - Create a new Pull Request.
This project is licensed under the MIT License. See the LICENSE file for details.