https://github.com/smartcraze/feedmeback
A feedback system allowing companies and users to submit, manage, and embed feedback, with authentication and company-specific testimonials
https://github.com/smartcraze/feedmeback
embeddings feedback-systems
Last synced: 23 days ago
JSON representation
A feedback system allowing companies and users to submit, manage, and embed feedback, with authentication and company-specific testimonials
- Host: GitHub
- URL: https://github.com/smartcraze/feedmeback
- Owner: smartcraze
- Created: 2025-01-10T05:54:53.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-29T10:09:20.000Z (4 months ago)
- Last Synced: 2025-03-30T10:33:45.629Z (about 2 months ago)
- Topics: embeddings, feedback-systems
- Language: TypeScript
- Homepage: https://feedmeback.surajv.me
- Size: 63.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **Feedback System for Companies and Users**
This repository provides a feedback system allowing companies and users to submit, manage, and embed feedback. It features company and user authentication, company-specific feedback, and a testimonial system where companies can embed feedback on their websites.
## **Features**
- **Company Admin Routes:**
- **Signup & Login:** Register and authenticate companies.
- **Company Profile:** View, update, or delete company details.
- **Feedback Management:** Companies can view feedback submitted by users.
- **Admin Functions:** Change password, search, and delete company profiles.
- **User Routes:**
- **Signup & Login:** Register and authenticate users.
- **Feedback Submission:** Authenticated users can submit feedback to specific companies.
- **Feedback System:**
- **Company Feedback:** Companies receive feedback from users that can be embedded on their website.
- **Feedback Retrieval:** Admins and users can view feedback related to a specific company.
- **Authentication & Authorization:**
- Secured routes using JWT authentication.
- Admin middleware to ensure only authenticated company admins can access their data.
## **Technologies Used**
- **Backend:** Node.js, Express.js, MongoDB, Mongoose
- **Authentication:** JWT (JSON Web Tokens)
- **Validation:** Zod for schema validation
- **Security:** bcrypt for password hashing
## **Installation**
To get started with the project, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/smartcraze/FeedMeBack.git
```
2. Navigate into the project directory:
```bash
cd FeedMeBack
```
3. Install the dependencies:
```bash
npm install
```
4. Set up environment variables in a `.env` file:
5. Start the server:
```bash
npm run dev
```
## **Contributing**
We welcome open-source contributions! If you're interested in contributing, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-name`).
3. Make your changes and commit them (`git commit -m 'Add some feature'`).
4. Push to the branch (`git push origin feature-name`).
5. Open a pull request to merge your changes into the `main` branch.
### **Contributions Guidelines:**
- Ensure your code is well-documented and follows the project's coding standards.
- Write tests for new features or bug fixes.
- Be respectful and constructive in all discussions and contributions.
### **Notion link**
https://www.notion.so/feedmeback-17678b1111b480be9c03d80e0870efef?pvs=4
# All EndPoints
```json
post http://localhost:3000/api/v1/user/signup
{
"name":"suraj vishwakarma",
"username":"suraj9880",
"email":"[email protected]",
"password":"fuckyou"
}
```
```json
post http://localhost:3000/api/v1/user/signin
body:
{
"username":"suraj9880",
"password":"fuckyou"
}
response
{
"Message":"User Logged In",
"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3OTY2MTU4NzI5MDFkMjJkMWE4OTFlZiIsImlhdCI6MTczNzkwODg3MX0.wsji-B2bJu-YyiWF1_eYyioVpa8fZBMbRzjSAGmUMT0"
}
```
```json
get http://localhost:3000/api/v1/user/me
[authorisation] headers
response
{
"message": "User details retrieved successfully",
"user": {
"name": "suraj vishwakarma",
"email": "[email protected]",
"username": "suraj9880",
"createdAt": "2025-01-26T16:22:48.870Z"
}
}
```
```json
put http://localhost:3000/api/v1/user/update
{
"name":"suraj vishwakarma",
"email": "[email protected]",
"username":"smartcraze"
}
```