Home

Here's a sample wiki for your project that you can use as a reference or modify according to your needs. This wiki covers the project overview, setup instructions, usage, and other relevant sections.

---

Anonymous Social Media App

Project Overview

The Anonymous Social Media App is designed to provide a platform for users to post and share their thoughts, ideas, and experiences without revealing their identity. This app aims to create a safe space for users to express themselves freely while connecting with others through shared interests and discussions.

Key Features

• User Registration: Allows users to create an account and log in securely.
• Posting: Users can create and share posts anonymously.
• Comments: Users can engage with posts through comments.
• Search Functionality: Users can search for posts with autocomplete suggestions.
• Chatting Feature: Real-time chatting capability using Socket.io.
• Location Field: Enhanced registration with location-based services using use-places-autocomplete.

Tech Stack

• Frontend: React, Chakra UI
• Backend: Express
• Database: PostgreSQL
• ORM: Prisma
• Real-time Communication: Socket.io

Getting Started

Prerequisites

Ensure you have the following installed on your machine:

• Node.js (LTS version recommended)
• PostgreSQL database server
• Git (for version control)

Clone the Repository

git clone https://github.com/your-username/anonymous-social-media-app.git
cd anonymous-social-media-app

Install Dependencies

1. Backend Dependencies:

   cd backend
   npm install

2. Frontend Dependencies:

   cd frontend
   npm install

Set Up the Database

1. Create a PostgreSQL database.

2. Configure your database connection in the .env file in the backend directory:

   DATABASE_URL=postgresql://username:password@localhost:5432/database_name
   

3. Run the database migrations:

   npx prisma migrate dev

Run the Application

1. Start the Backend Server:

   cd backend
   npm run dev

2. Start the Frontend Development Server:

   cd frontend
   npm start

Usage

• Navigate to http://localhost:3000 in your web browser to access the application.
• Register a new account or log in using existing credentials.
• Create posts and engage with others through comments.
• Use the search bar to find posts by entering keywords.

Folder Structure

anonymous-social-media-app/
├── backend/             # Backend server code
│   ├── src/             # Source files
│   ├── .env             # Environment variables
│   ├── package.json      # Backend dependencies
│   └── ...
├── frontend/            # Frontend application code
│   ├── src/             # Source files
│   ├── .env             # Environment variables
│   ├── package.json      # Frontend dependencies
│   └── ...
└── README.md            # Project documentation

Contributing

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Make your changes and commit them (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Chakra UI for the UI components.
• Socket.io for real-time communication.
• Prisma for easy database management.

---

Feel free to adjust the content, add more sections, or customize the information to better fit your project specifics! Let me know if you need further assistance.