Skip to content

TechByChoice/tbc-members-core-ui

Repository files navigation

TBC Members Core UI

Welcome to the TBC Members Core UI project! This open-source project is part of Tech by Choice's initiative to create a comprehensive UI for managing members. It's designed to be community-driven and welcomes contributions from developers of all skill levels.

About the Project

Project Purpose:

The TBC Members Core UI aims to provide a user-friendly interface for managing membership data for organizations. This site helps Tech by Choice, a non-profits tech community, streamline their member management processes and programing. The project addresses common challenges such as member registration, profile management, and member communication, ultimately enhancing the overall experience for both administrators and members.

Features:

  • Member registration and login
  • Profile management
  • Mentorship program management
  • Company Reviews
  • Org wide updates (email, newsletters)
  • Event management
  • Community Reporting and analytics

Screenshots/Demos: Coming soon

Getting Started

Prerequisites

  • Node.js
  • npm (comes with Node.js)

Installation

  1. Clone the repository:

    git clone https://github.com/TechByChoice/tbc-members-core-ui.git
    
  2. Navigate to the project directory:

    cd tbc-members-core-ui
    
  3. Install dependencies:

    npm install

Running the Project

  • Development server:
    npm run dev
  • Build the project:
    npm run build
  • Preview the build:
    npm run preview

Environment Variables

  • Set up .env as per src/example.env.

Contributing

We actively welcome your pull requests and contributions. Please read our CONTRIBUTING.md for guidelines on how to contribute.

Reporting Issues

  • Use the GitHub Issues page to report issues.
  • Clearly describe the issue including steps to reproduce when it is a bug.

Submitting Enhancements

  • Submit enhancement suggestions through GitHub Issues.
  • Be clear and detailed in your explanation of the proposed feature or improvement.

Community

Code of Conduct

The Open TBC Program adheres to the Tech By Choice Code of Conduct, fostering a respectful and inclusive environment. Read our Code of Conduct.

License

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

Acknowledgments

  • Mention any individuals or organizations that have contributed significantly to the project.
  • Acknowledge any third-party assets or libraries used in the project.

Support the Project

We have multiple ways for you to support our work!

Donations

As aa nonprofit community, every donation big or small helps us continue our work. Become a Github sponsor to help our community keep growing!

Contributions

We're seeking contributions in the following areas:

Mentorship: Share your expertise and guide our cohort members. Content Creation: Help us create tutorials, blogs, and documentation. Administrative Support: Assist in managing teams and projects efficiently. Interested in contributing? Reach out to us at [email protected] or join our Slack channel.

Roadmap

  • Project roadmap coming soon

Changelog

Project changelog coming soon