TDevUIT / PirateSocial

Make awesome things! We connect a public who have a pirate mind to do pirate things.
0 stars 2 forks source link
social socket-io

PirateSocial

PirateSocial is a web-based chat application that connects individuals who have a pirate spirit to do pirate-like things. Our platform is built with modern web technologies to provide fast, secure, and scalable real-time communication.

Features

Tech Stack

Frontend

Backend

Other Tools and Technologies

Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/TDevUIT/PirateSocial.git
    cd PirateSocial
  2. Install dependencies for both the frontend and backend:

    # Navigate to the frontend
    cd frontend
    npm install
    
    # Navigate to the backend
    cd ../backend
    npm install
  3. Set up your .env files for both the frontend and backend (example provided in .env.example files).

  4. Run the development server:

    # Frontend (Next.js)
    cd frontend
    npm run dev
    
    # Backend (NestJS)
    cd ../backend
    npm run start:dev

Running with Docker

To run the entire application with Docker, use the following commands:

docker-compose up --build

this will start both the frontend and backend services, along with PostgreSQL and Redis containers.

Contributing

We welcome contributions from the community! To get started:

  1. Fork the repository.
  2. Create a new branch for your feature/bugfix.
  3. Submit a pull request with a detailed description.

    License

    PirateSocial is licensed under the MIT License.