Skip to content

Codekmt/Team-Skaz

Repository files navigation

ForgeFlow

Welcome to the ForgeFlow! This project is designed to provide a simple yet powerful platform where users can post questions, add accurate answers to frequently asked questions (FAQ), and browse posts efficiently using tags.

Features

1. Post Questions and Answers

  • Users can easily post their questions.
  • Answers can be added, making the forum a dynamic FAQ for the community.

2. FAQ Management

  • Pin frequently asked questions with their respective answers to a dedicated FAQ section.
  • Simplified FAQ browsing for quick access to the most important information.

3. Tag-Based Filtering

  • Categorize posts using tags for better organization.
  • Search and filter posts based on tags for an intuitive and efficient user experience.

Getting Started

Follow these steps to set up the project locally.

Prerequisites

Installation

  1. Clone the repository:
    git clone https://github.com:Codekmt/Team-Skaz.git
  2. Navigate to the project directory:
    cd forum-faq-tagging
  3. Install dependencies:
    npm install
    or
    yarn install

Run the Development Server

Start the local development server:

npm run dev:teamsfx

or

yarn dev:teamsfx

Run the Backend Server

Navigate to src/backend

Visit [http://localhost:53000](http://localhost:53000) in your browser to view the application.

## Usage

1. **Adding Questions and Answers**
   - Navigate to the "Post a Question" section to submit a new question.
   - Provide an answer if your question is suitable for the FAQ.

2. **Filtering by Tags**
   - Use the search bar or tag cloud to filter posts based on specific topics.
   - Combine multiple tags for precise results.

3. **Managing the FAQ**
   - Admins or moderators can pin questions to the FAQ section for better visibility.
   - FAQs are automatically updated when new answers are added.

## Technologies Used

- **Frontend**: React
- **Backend**: Node.js, Express
- **Database**: Supabase
- **Styling**: CSS

## Contributing

Contributions are welcome! Feel free to submit issues or pull requests.

1. Fork the repository.
2. Create your feature branch:
   ```bash
   git checkout -b feature/YourFeature
  1. Commit your changes:
    git commit -m "Add YourFeature"
  2. Push to the branch:
    git push origin feature/YourFeature
  3. Open a pull request.

Thank you for using ForgeFlow! 🎉

About

Repository for our project for arcelor mittal

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors