Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carlosazaustre/community-pro
Web application to manage a dynamic digital community. The platform will feature an interactive feed where members and administrators can start and engage in conversations
https://github.com/carlosazaustre/community-pro
clean-architecture next postgresql tailwindcss vercel
Last synced: 9 days ago
JSON representation
Web application to manage a dynamic digital community. The platform will feature an interactive feed where members and administrators can start and engage in conversations
- Host: GitHub
- URL: https://github.com/carlosazaustre/community-pro
- Owner: carlosazaustre
- License: mit
- Created: 2024-10-10T18:28:39.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-10-18T18:32:07.000Z (28 days ago)
- Last Synced: 2024-11-01T16:22:12.932Z (14 days ago)
- Topics: clean-architecture, next, postgresql, tailwindcss, vercel
- Language: TypeScript
- Homepage: https://community-pro-app.vercel.app/
- Size: 454 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Community Web Application
Welcome to the repository for the **Community Web Application**. This project is a minimal viable product (MVP) designed to create a platform where users can engage in conversations, share ideas, and connect with other members. The application features user authentication, conversation feeds, commenting, notifications, and a member ranking system.
---
## Table of Contents
- [Community Web Application](#community-web-application)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Environment Variables](#environment-variables)
- [Running the Application](#running-the-application)
- [API Documentation](#api-documentation)
- [Database Schema](#database-schema)
- [Project Structure](#project-structure)
- [Applied Clean Architecture principles](#applied-clean-architecture-principles)
- [Components and Their Roles](#components-and-their-roles)
- [Entities (`src/domain/entities`):](#entities-srcdomainentities)
- [Repository Interfaces (`src/domain/interfaces`):](#repository-interfaces-srcdomaininterfaces)
- [Use Cases (`src/application/use-cases`):](#use-cases-srcapplicationuse-cases)
- [Repositories (`src/infrastructure/database`):](#repositories-srcinfrastructuredatabase)
- [Mappers (`src/infrastructure/mappers`):](#mappers-srcinfrastructuremappers)
- [DTOs (`src/application/dtos`):](#dtos-srcapplicationdtos)
- [How Everything Connects](#how-everything-connects)
- [Contributing](#contributing)
- [Steps to Contribute](#steps-to-contribute)
- [Guidelines](#guidelines)
- [License](#license)
- [Contact](#contact)
---
## Features
- **User Authentication**: Register, login, logout, and password recovery functionality.
- **User Profiles**: View and update personal profiles.
- **Conversation Feed**: Browse recent conversations and posts.
- **Create Conversations**: Start new conversations with topic tagging.
- **Commenting**: Engage in discussions by commenting on conversations.
- **Notifications**: Receive notifications about replies and interactions.
- **Members Ranking**: View top community members based on activity.
- **Responsive Design**: User interface optimized for mobile, tablet, and desktop devices.
---
## Technologies Used
- Web:
- [React](https://reactjs.org/) & [Next](https://nextjs.org)
- [TailwindCSS](https://tailwindcss.com/)
- Database:
- [PostgreSQL](https://www.postgresql.org/)
- Authentication:
- [JSON Web Tokens (JWT)](https://jwt.io/)
- API Documentation:
- OpenAPI (Swagger)
- Dev Tools:
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
---
## Getting Started
### Prerequisites
- **Node.js** (v20 or higher)
- **npm**
- **PostgreSQL** (v12 or higher)
- **Git**
### Installation
1. **Clone the Repository**
```bash
git clone https://github.com/yourusername/community-app-mvp.git
cd community-app-mvp
```
2. **Install Dependencies**
```bash
# Using npm
npm install
```
### Environment Variables
Create a `.env` file in the root directory of the project and add the following environment variables:
```env
# .env
DATABASE_URL="postgresql://USER:PASSWORD@HOST:PORT/DATABASE_NAME"
JWT_SECRET="your_jwt_secret_key"
PORT=3000
```
Replace `USER`, `PASSWORD`, `HOST`, `PORT`, and `DATABASE_NAME` with your PostgreSQL database credentials.
### Running the Application
**Development Mode**
```bash
npm run dev
```
This command starts the server with hot reloading using Nodemon.
**Production Mode**
```bash
npm start
```
---
## API Documentation
The API follows RESTful principles and is documented using OpenAPI (Swagger).
- **Swagger UI**: Access the interactive API documentation at http://localhost:3000/api-docs when the server is running.
- **OpenAPI Specification**: The OpenAPI spec is located at `docs/openapi.yaml`.
For detailed information about the API endpoints, request/response formats, and error handling, refer to the [API Documentation](./docs/api.md).
---
## Database Schema
The database schema is designed using PostgreSQL
For an in-depth explanation of the database structure, entities, and relationships, refer to the [Database Schema Documentation](./docs/database.md)
---
## Project Structure
```plaintext
community-pro/
├── .husky/
├── docs/
├── public/
├── src/
│ ├── app/
│ │ ├── api/
│ │ ├── fonts/
│ │ ├── globals.css
│ │ ├── layout.tsx
│ │ └── page.tsx
│ ├── components/
│ │ └── ui/
│ ├── application/
│ │ ├── dtos/
│ │ └── use-cases/
│ ├── domain/
│ │ ├── entities/
│ │ └── interfaces/
│ ├── infraestructure/
│ │ ├── database/
│ │ └── mappers/
│ └──lib/
├── .prettierrc
├── tailwind.config.ts
├── postcss.config.mjs
├── components.json
├── docker-compose.yml
├── next-env.d.ts
├── next.config.mjs
├── package.json
├── .eslintrc.json
├── .gitignore
└── tsconfig.json
```
- `src/`: Contains the application source code.
- **`/app`**: Next App Router logic for pages
- **`components/`**: Reusable React components.
- **`components/ui`**: Shadcn UI Components
- **`domain/`**: Entities and Interfaces
- **`infraestructure/`**: Logic related to database and mappers
- **`application/`**: Use Cases related to business logic and DTOs
- **`lib/`**: Utils
- **`public/`**: Contains static assets.
- **`docs/`**: Contains documentation files.
---
## Applied Clean Architecture principles
- **Independence from Frameworks**: Our domain code and business logic do not depend on any external framework.
- **Testability**: By separating responsibilities, we can test each component in isolation.
- **Independence from the UI**: Our business logic can operate without a specific user interface.
- **Independence from the Database**: Our domain is unaware of data persistence details.
- **Independence from Any External Agency**: Our business core does not depend on anything external.
## Components and Their Roles
#### Entities (`src/domain/entities`):
- Represent the application's business objects.
- Contain the most general and high-level business rules.
- **Example**: `Conversation`, `User`, `Topic`
#### Repository Interfaces (`src/domain/interfaces`):
- Define contracts for data access.
- Allow the domain to specify how it wants to persist data without worrying about implementation details.
- **Example**: `ConversationRepository`
#### Use Cases (`src/application/use-cases`):
- Contain application-specific business rules.
- Orchestrate the flow of data to and from the entities.
- **Example**: `GetConversationsUseCase`
#### Repositories (`src/infrastructure/database`):
- Implement the repository interfaces defined in the domain.
- Handle the details of data persistence and retrieval.
- **Example**: `VercelPostgresConversationRepository`
#### Mappers (`src/infrastructure/mappers`):
- Transform data between domain representations and external ones (like DTOs).
- Help maintain separation between the domain and external layers.
- **Example**: `ConversationMapper`
#### DTOs (`src/application/dtos`):
- Data Transfer Objects that define how data communicates with the outside world.
- Help decouple the internal representation of data from the external one.
#### How Everything Connects
- **Use Cases** are the central point. They implement the application-specific business logic.
- **Use Cases** work with **Entities** that represent the core of the domain.
- To access or persist data, **Use Cases** use **Repository Interfaces**.
- Concrete **Repository Implementations** (like `PrismaConversationRepository`) provide the actual implementation of these interfaces.
- **Mappers** are used to convert between domain **Entities** and **DTOs**, keeping the domain clean from external concerns.
- The **Presentation Layer** (such as controllers or API handlers) uses **Use Cases** and works with **DTOs**.
---
## Contributing
We welcome contributions to improve this project!
### Steps to Contribute
1. **Fork the Repository**
Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.
2. **Clone Your Fork**
```bash
git clone https://github.com/yourusername/community-pro.git
cd community-pro
```
3. **Create a New Branch**
```bash
git checkout -b feature/your-feature-name
```
4. **Make Changes**
Implement your feature or fix.
5. **Commit Changes**
```bash
git add .
git commit -m "Add your commit message here"
```
6. **Push to Your Fork**
```bash
git push origin feature/your-feature-name
```
7. **Create a Pull Request**
Go to the original repository and click on [Pull Requests](https://github.com/carlosazaustre/community-pro/pulls), then "New Pull Request". Follow the prompts to submit your pull request.
### Guidelines
- Follow the existing code style and architecture.
- Write clear commit messages.
- Update documentation if necessary.
- Ensure that your code passes all tests and lints.
---
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
---
## Contact
If you have any questions or suggestions, feel free to open an issue or reach out directly.