The Crew

Table of Contents

• Introduction
• Installation
• Features
• Code Features
• Technologies used to build this project
• Other Libraries/Platforms Used
• Contributors ✨
• License

Introduction

The Crew is a platform that helps in finding the basic necessity services available in one’s localities such as plumbing, electrical works, beautician,salon or carpentry work. A dedicated platform designed for a service provider makes it handy to market the services and also can manage his work online, as well as for customer to book and avail any service at any given point of time. The Crew is a responsive platform, hence users can access it across all devices. Our goal is to make the best user experience UI design and easy to use.

Live demo here

Sample creds

username : [email protected]
password: Password@123

Installation

• Clone this repository to your local machine
• Use the yarn command to install dependencies
• Inside the root directory:
  • Run command yarn start the-crew-ui to open the app in your browser of choice
  • Run command yarn start the-crew-api to start the backend service.
• Several environment variables are needed to run the app. Below are listed:

// port number where backend will host
NX_PORT= // optional (defaults to 3000)

// frontend url
NX_CORS_ORIGINS=http://localhost:4200,http://localhost:4000 // must be comma separated

NX_JWT_SECRET= // required
NX_COOKIE_SECRETS= // optional (must be comma separated)
NX_JWT_ISSUER= // optional (defaults to nestjs)
NX_ACCESS_TOKEN_EXPIRE= // optional (defaults to 24h)
NX_REFRESH_TOKEN_EXPIRE= // optional (defaults to 7d)
NX_COOKIE_EXPIRE= // optional (defaults to 7d)

NX_TYPEORM_DB_TYPE= // optional (defaults to postgres)
NX_TYPEORM_PORT= // optional (defaults to 5432)
NX_TYPEORM_HOST= // required
NX_TYPEORM_USERNAME= // required
NX_TYPEORM_PWD= // required
NX_TYPEORM_DB= // required

// backend url with which the frontend will interact
NX_API_URL=http://localhost:3000/api // required
NX_CONVENIENCE_FEE=39 // required (must be number)

NX_GOOGLE_AUTH_CLIENT_ID= // required
NX_STRIPE_PRIVATE_KEY = // required

Features

• List of locations where The Crew is operated currently.
• Types of services provided such as Carpentry, plumbing, salon etc and options to search.
• List of services with details available, FAQs and most recent reviews.
• Services can be added to cart for later booking.
• Review and rate for obtained service.
• Bookings (ongoing and history)
• Select existing address or create new address while booking a service.
• Onboarding the user as a customer or service provider (professional).

Code Features

• Nx Monorepo workspace
• NestJS backend framework
• React functional components used with hooks
• Material-UI styled components
• Global state management using Redux (Redux Toolkit)
• Login using email & password and Google SSO
• Payment gateway integration (Stripe)
• Frontend is hosted on Netlify
• Backend is hosted on Heroku
• DB hosted on AWS RDS

Technologies used to build this project

Other Libraries/Platforms Used

Contributors ✨

Akshay Mahajan
Sri Vithal Sai Krishna

License

MIT