Skip to content

Latest commit

 

History

History
79 lines (47 loc) · 2.16 KB

README.md

File metadata and controls

79 lines (47 loc) · 2.16 KB

proview

Overview

This project is a web application which allows users to create a customizable landing page with multiple links to various destinations. It utilizes MongoDB, Express.js, Node.js, and Vite for server-side and client-side development.

Running Using Docker

Install docker and docker-compose and in the project root folder run the following command

sudo docker-compose up

This will run the client at http://localhost:5173 and the node.js backend server http://localhost:4000

Features

  • Share Page: A sharable landing page containing all the user's links.
  • Links Page: Allows users to edit, create, and deploy links.
  • Profile Editing: Users can update their profile information.

Technologies Used

  • MongoDB: NoSQL database for storing user data and links.
  • Express.js: Backend framework for handling HTTP requests and routing.
  • Node.js: JavaScript runtime for server-side development.
  • Vite: Build tool for front-end development.
  • HTML/CSS/JavaScript: For building the user interface and interactivity.

Getting Started

Prerequisites

  • Node.js and npm installed on your machine.
  • MongoDB installed locally or accessible remotely.

Installation

  1. Clone the repository:

git clone https://github.com/Aditya5510/proview.git

  1. Navigate to the project directory:

  2. Install dependencies:

npm install

  1. Set up environment variables:

.env.local

Update the .env file with your MongoDB connection string and other configuration settings.

  1. Start the server:

npm start

markdown

  1. Access the application at http://localhost:5173.

Usage

  1. Sign up or log in to your account.
  2. Navigate to the Links Page to manage your links or the Profile Page to update your profile.
  3. Share your shareable landing page URL with others to showcase your links.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Commit your changes (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature/your-feature).
  5. Create a new Pull Request.