Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 2.69 KB

README.md

File metadata and controls

83 lines (56 loc) · 2.69 KB

Ownly - Product Rental Platform for SNU Community

Welcome to Ownly, a website where the SNU community can rent, list, and request products. Ownly is built using Next.js and Supabase to provide a seamless experience for product rentals within the university community.

Features

  • User Authentication: Secure login, signup, and logout functionality.
  • Product Listing: Users can list products they want to rent out.
  • Product Requests: Users can request specific products they need.
  • Community Focused: Exclusively designed for the SNU community.
  • Real-time Data: Integration with Supabase for real-time database updates.

Getting Started

Prerequisites

Before you begin, make sure you have the following software installed on your machine:

Installation

  1. Clone this repository to your local machine:

    git clone <repository_url>
cd ownly

  2. Install dependencies:

    npm install
or
yarn install

  3. Configure environment variables:

    Create a .env.local file in the root of your project and add the following environment variables:

    NEXT_PUBLIC_SUPABASE_URL='YOUR_SUPABASE_URL'
NEXT_PUBLIC_SUPABASE_ANON_KEY='YOUR_SUPABASE_ANON_KEY'

  4. Start the development server:

    npm run dev
or
yarn dev

  5. Your application should now be running at http://localhost:3000.

Usage

  • Product Management: Users can list products they want to rent out and browse or request products listed by others.
  • User Authentication: Implemented using Supabase Auth for secure and easy authentication.
  • Real-time Updates: All changes to product listings and requests are updated in real-time using Supabase.

Deploying

To deploy Ownly, follow the deployment instructions for your chosen hosting platform. Popular options include:

Ensure that your environment variables are set correctly on your hosting platform.

Additional Resources

Thank you for choosing Ownly! We hope you enjoy using our platform to rent and list products within the SNU community. If you have any questions or need further assistance, please feel free to contact us.