adeeena / mikroagresszi-wiki

Wiki website to list different micro-agression types with examples.

MikroagressziWiki

Welcome to MikroagressziWiki, a project built with Angular 13, dedicated to serving as a Hungarian LGBTQ Info Sharing Wiki and community resource.

Table of Contents

• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License

Features

• User-Friendly Interface: An intuitive and accessible user interface designed to make it easy for users to find and contribute information.
• Content Sharing: Users can create, edit, and share articles, resources, and stories related to LGBTQ topics in Hungary.
• Search Functionality: Powerful search capabilities to quickly find relevant content.
• Community Support: A platform to connect with the LGBTQ community, ask questions, and find support.
• Multilingual: Support for multiple languages to make the information accessible to a wider audience.

Getting Started

Prerequisites

Before you start, ensure you have met the following requirements:

• Node.js installed
• Angular CLI installed globally

Installation

1. Clone the repository:

   git clone https://github.com/adeeena/mikroagresszi-wiki.git

2. Navigate to the project directory:

   cd mikroagresszi-wiki

3. Install dependencies:

   npm install

4. Start the development server with the client:

   ng serve

5. Start the development server with the server:

   cd ../api
   npm install
   node server.js

6. Open your web browser and visit http://localhost:4200 to access the application.

6B. The API can be found at http://localhost:3000.

Usage

• Explore and navigate through the MikroagressziWiki wiki to find information.
• (future) Use the search functionality to quickly locate specific topics or resources.

Contributing

We welcome contributions from the community. If you would like to contribute to MikroagressziWiki, please follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository locally.
3. Create a new branch for your feature or bug fix.
4. Make your changes and test them.
5. Commit your changes and push them to your fork on GitHub.
6. Create a Pull Request (PR) to submit your changes for review.

Please follow our Contributing Guidelines for more details.

License

This project is licensed under the MIT License.

---

Thank you for contributing to MikroagressziWiki! Your support helps make this platform a valuable resource for the LGBTQ community in Hungary.