Retro

An online platform providing items of vintage collections!

Stars	🍴 Forks	Issues	Open PRs	Closed PRs

🎥Demo

retro.mp4

Table of Contents

1. Featured In
2. About Us
3. Tech Stack
4. Installation Instructions
5. Contributing
6. Website Preview
7. Our Contributors
8. Stargazers
9. Forkers
10. Code of Conduct
11. License

Featured In

Event Logo	Event Name	Event Description
	Social Winter of Code Season-5 (SWOC) 2024-2025	Social Winter Of Code is the 2 month long open source program, with the aim to introduce more and more people to the world of Open source. In this program all the selected participants will get a chance to work on various exciting projects under the guidance of experienced Mentors.
	GirlScript Summer of Code 2024'EXTD	GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.
	Hacktoberfest 2024	Hacktoberfest is a month-long celebration of open source software run by DigitalOcean, GitHub, and Twilio. It encourages contributions to open source projects and promotes a global community of developers.

About Us

Welcome to RETRO! 🌕✨ We invite you to explore the vintage look, a unique journey through timeless designs and aesthetics. Our platform celebrates the elegance of the past, blending classic styles with modern usability to create a seamless, visually stunning experience.

At Retro, we believe that beauty lies in the details, and our website reflects a passion for vintage-inspired design that transports you to a world where nostalgia meets innovation. Whether you're here for inspiration, design exploration, or simply to immerse yourself in a vintage ambiance, we aim to make your experience truly special.

Discover the charm of the past and embrace a sophisticated, artistic vibe that never goes out of style. Join us, and let's relive the beauty of the bygone eras, one step at a time! 🌸🕰️

It is an online platform which enables you to get information about your vintage collections and to place the orders.

Tech Stack

HTML5 structures the website's content, enabling modern multimedia support and semantic layout.

JavaScript adds interactivity, making the site dynamic with features like form validation and real-time content updates.

Bootstrap provides a responsive framework with pre-built components for consistent design across devices.

CSS3 styles the website, enhancing its appearance and ensuring an adaptive layout.

Installation Instructions

Follow the steps below to set up and run the project locally:

1. Clone the Repository

Clone the repository to your local machine using the following command:

git clone https://github.com/Anjaliavv51/Retro.git

2. Run the Frontend

The frontend is a static application. To run it:

1. Navigate to the frontend folder (if applicable) or locate the index.html file in the project root.
2. Open the index.html file in your browser.

3. Run the Backend

1. Prerequisites

Before running the backend, ensure the following software is installed on your machine:

• Node.js: Install a compatible version for the project. Download Node.js

• Git: Version control system. Download Git

• pnpm: A fast, disk-efficient Node.js package manager.

  Install pnpm globally using npm:

  npm install -g pnpm

  Verify the installation by checking the version:

  pnpm --version

2. Navigate to Backend

Change your directory to the backend folder:

cd backend

3. Create a .env File

In the backend folder, create a .env file to store environment variables:

touch .env

4. Configure Environment Variables

Add the following variables to the .env file:

PORT=3000
MONGODB_URL=ADD YOUR MONGODB ATLAS DRIVER CONNECTION STRING
SECRET=INPUT YOUR SECRET KEY. SAMPLE: MYSECRET123

5. MongoDB URL Setup

To get the MongoDB URL, follow these steps:

1. Login to MongoDB Atlas: MongoDB Atlas Login
2. Create a New Project:
   • In your MongoDB Atlas account, create a new project.
3. Create a New Cluster:
   • Under the newly created project, create a new cluster.
4. Create a New Database:
   • Inside the cluster, create a new database named retro_db.
5. Get the Connection String:
   • Click on the cluster, select Connect, and retrieve the connection string.
   • Replace <username> and <db_password> with your MongoDB Atlas credentials.
     Example:

   mongodb+srv://<username>:<db_password>@cluster....mongodb.net/retro_db

4. Start the Backend

1. Install dependencies using pnpm:

   pnpm install

2. Start the backend server:

   pnpm start

3. The backend should now be running on http://localhost:3000.

Contributing

⚠️Before contributing to this project, be sure to read and adhere to the Contributing Guidelines.

Thank you for considering contributing to Retro. We welcome and appreciate contributions from the community!

If you find a bug, have a feature request, or would like to contribute in any way, feel free to open an issue or submit a pull request. Whether you're enhancing the technical documentaion or adding a new feature, your efforts are valued, and together we can make this project even better. Thank you for considering contributing to Retro!

Website Preview📸

🌐 Visit our website: Retro

Our Contributors

Thank you for contributing to our repository

Stargazers

Forkers

Code of Conduct

We are committed to fostering a welcoming and inclusive environment for everyone. All contributors and participants are expected to uphold the following values:

• Be respectful of different viewpoints and experiences.
• Show empathy toward others.
• Use inclusive language.

Please read and follow our Code of Conduct to foster an inclusive community. If anyone violates these standards, they may be banned from the community.

License 📜

This project is licensed under the MIT License. For more details, see the LICENSE file.

If you find this project helpful, please consider giving it a star!