Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 4.52 KB

README.md

File metadata and controls

105 lines (71 loc) · 4.52 KB

MyClothes

GitHub Release GitHub Tag License

Welcome to MyClothes, where creativity meets fashion! This application provides a platform for designers to showcase their clothing products, receive feedback through comments and likes, engage in real-time chat, and even get hired by clients who love their work.


Table of Contents

Installation

git clone https://github.com/StefanPenchev05/MyClothesV2.git
cd server
npm install
cd ../client
npm install

Usage

Effortlessly kickstart the MyClothes application by launching both the Express.js backend and Next.js frontend with a few simple commands. Follow the instructions below to bring the creativity and fashion of MyClothes to life on your local machine.

Running the Express Server

Navigate to the server directory to awaken the backend spirit of MyClothes. Use the following commands to start the Express.js server, which breathes life into our platform's backend functionalities:

cd server  # Step into the heart of our backend
npm run start  # Summon the Express.js server into action

Running the NextJS Server

To start the NextJS server, navigate to the root directory of your frontend project in your terminal and run the following command:

cd client  # Dive into the realm of our frontend
npm run build  # Architect the foundation of your Next.js application
npm run start  # Illuminate the frontend spectacle

Features

  • Showcase clothing products
  • Receive and give feedback through comments and likes
  • Real-time chat functionality
  • Opportunity for designers to get hired

Acknowledgements

This project leverages several open-source libraries and tools to function effectively. We extend our gratitude to the developers and contributors of these projects for making our work easier and more efficient. Below is a list of the major dependencies used in this project:

  • bcrypt - A library to help you hash passwords.

  • body-parser - Node.js body parsing middleware.

  • cors - A package to enable CORS (Cross-Origin Resource Sharing) with various options.

  • dotenv - Loads environment variables from a .env file into process.env.

  • express - Fast, unopinionated, minimalist web framework for Node.js.

  • helmet - Helps secure your apps by setting various HTTP headers.

  • jsonwebtoken - An implementation of JSON Web Tokens.

  • mongoose - Elegant mongodb object modeling for Node.js.

  • morgan - HTTP request logger middleware for Node.js.

  • multer - Middleware for handling multipart/form-data.

  • nodemailer - A module for Node.js applications to allow email sending.

  • socket.io - Enables real-time, bidirectional and event-based communication.

  • uuid - For the creation of RFC4122 UUIDs. Development tools and libraries that greatly assisted in the development process:

  • @babel/preset-env - A Babel preset for each environment.

  • babel-jest - Jest plugin to use babel for transformation.

  • jest - Delightful JavaScript Testing.

  • nodemon - Monitors for any changes in your source and automatically restarts your server.

  • supertest - Super-agent driven library for testing HTTP servers.

We acknowledge and thank all the maintainers and contributors of these projects for their hard work and dedication.

Contributors

License

MIT