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.
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
- 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.
- 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.
- Node.js and npm installed on your machine.
- MongoDB installed locally or accessible remotely.
- Clone the repository:
git clone https://github.com/Aditya5510/proview.git
-
Navigate to the project directory:
-
Install dependencies:
npm install
- Set up environment variables:
.env.local
Update the .env file with your MongoDB connection string and other configuration settings.
- Start the server:
npm start
markdown
- Access the application at
http://localhost:5173.
- Sign up or log in to your account.
- Navigate to the Links Page to manage your links or the Profile Page to update your profile.
- Share your shareable landing page URL with others to showcase your links.
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature). - Commit your changes (
git commit -am 'Add new feature'). - Push to the branch (
git push origin feature/your-feature). - Create a new Pull Request.