Skip to content

Latest commit

 

History

History
113 lines (75 loc) · 3.42 KB

README.md

File metadata and controls

113 lines (75 loc) · 3.42 KB
Raw

💍 Marriage Platform (WIP)

This project is designed to help Shi'a students at our university connect with potential spouses in a safe and respectful environment.

🚀 Features

  • Profile Creation: Users can create and manage their profiles.
  • User Authentication: Secure sign-up and login mechanisms.
  • Connection Requests: Users can request contact information with mutual consent.
  • Responsive Design: Accessible on both desktop and mobile devices.

⚙️ Technologies Used

Rust Axum SQLx Yew PostgreSQL

  • Backend:

    • Rust: A safe, concurrent, and practical language.
    • Axum: A web framework that focuses on ergonomics and modularity.
    • SQLx: An async SQL toolkit for Rust.

  • Frontend:

    • Yew: A modern Rust framework for creating multi-threaded front-end web apps with WebAssembly.

  • Database:

    • PostgreSQL: A powerful, open-source relational database system.

📦 Getting Started

Prerequisites

Clone the Repository

git clone https://github.com/smarizvi110/marriage_platform.git
cd marriage_platform

Backend Setup

  1. Create a .env file in the backend directory using the provided .env.example as a template:

    cp backend/.env.example backend/.env

  2. Update the .env file with your PostgreSQL database credentials.

  3. Run the migrations:

     cd backend
 cargo sqlx migrate run

  4. Start the backend server:

     cargo run

Frontend Setup

  1. Build and run the frontend

    cd frontend
trunk serve

  2. Open your browser and navigate to http://localhost:8080.

🤝 Contributing

We welcome contributions to enhance this project! Here’s how you can contribute:

  1. Fork the Repository: Click the fork button to create your copy.

  2. Create a Branch:

     git checkout -b feature/your-feature-name

  3. Make your changes: Implement your feature or fix a bug.

  4. Commit your changes:

     git commit -m "Your commit message"

  5. Push to your fork:

     git push origin feature/your-feature-name

  6. Create a Pull Request: Open a pull request to the main branch of the original repository with your changes.

📝 License

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

Feel free to reach out if you have any questions or need assistance.