Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abdeLKabir-56 authored May 14, 2024
1 parent 2fda0e5 commit 8d4b6ae
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Wander - A Collaborative Social App for Travelers

Wander is a collaborative social application designed for travelers to share their experiences, stories, and adventures with a community of fellow travelers. The platform allows users to create blog posts, interact with other users through comments and likes, discover new destinations, and connect with like-minded individuals.

## Overview

Wander aims to provide a comprehensive platform for travelers to:

- Share their travel experiences through blog posts
- Interact with other users by commenting on posts and liking content
- Discover new destinations and get inspired for their next adventure
- Connect with a community of fellow travelers to exchange tips, recommendations, and stories

## Key Features

### User Authentication and Authorization

Wander implements user authentication and authorization using JSON Web Tokens (JWT), ensuring secure access to user accounts and protected resources.

### Blog Post Management

Users can create, edit, and delete blog posts, including uploading images and categorizing posts based on destination or theme.

### Interactive Features

Wander includes interactive features such as commenting on posts, liking content, and signaling inappropriate or offensive posts for moderation.

### Real-time Updates (Optional)

The platform supports real-time updates using Socket.IO, enabling live chat and notifications for users.

### Chatbot Integration

Wander integrates a chatbot powered by Google Generative AI, providing users with personalized recommendations, travel tips, and answers to common questions.

### API Documentation

The project includes comprehensive API documentation using the OpenAPI Specification, facilitating easy integration with external services and clients.

## Technologies Used

- Node.js ![Node.js](https://img.icons8.com/color/48/000000/nodejs.png)
- Express.js ![Express.js](https://img.icons8.com/color/48/000000/expressjs.png)
- MongoDB ![MongoDB](https://img.icons8.com/color/48/000000/mongodb.png)
- Mongoose ![Mongoose](https://img.icons8.com/color/48/000000/mongoose.png)
- JSON Web Tokens (JWT) ![JWT](https://img.icons8.com/color/48/000000/json.png)
- bcrypt ![bcrypt](https://img.icons8.com/ios-filled/50/000000/lock-2.png)
- dotenv ![dotenv](https://img.icons8.com/ios/50/000000/password.png)
- multer ![multer](https://img.icons8.com/ios/50/000000/upload.png)
- Chart.js ![Chart.js](https://img.icons8.com/ios/50/000000/combo-chart.png)
- Google Generative AI ![Google Generative AI](https://img.icons8.com/color/48/000000/google-logo.png)
- Socket.IO (optional) ![Socket.IO](https://img.icons8.com/color/48/000000/socket-io.png)
- OpenAPI Specification ![OpenAPI](https://img.icons8.com/color/48/000000/api.png)

## Getting Started

To get started with Wander, follow these steps:

1. Clone the repository to your local machine.
2. Install dependencies using npm or yarn.
3. Set up environment variables using a .env file.
4. Run the application using Node.js.

## Contributing

Contributions to Wander are welcome! If you'd like to contribute, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure tests pass.
- Submit a pull request with a detailed description of your changes.

0 comments on commit 8d4b6ae

Please sign in to comment.