Printease-backend 🖨️

Introduction

Printease is a SaaS application designed to streamline the print ordering process for students and print shops near universities. It allows print shop owners to accept online print orders easily, reducing the need for students to wait in queue. With Printease, students can place print orders online and simply pick them up at the shop, saving time and avoiding queues.

Note

There are no logistics involved. Students have to get to the shop physically to get their printouts without waiting in the queue

More Details

Table of Contents 🗒️

• Introduction
• Features
• Tech Stack
• Project Setup Guide
• Credentials for Testing
• Useful links and Credits

Features and Pages 🌟

Types of Pages (based on Types of Users 👨‍🦲)

1. Common Pages
2. Customer Pages
3. Shop-Owner Pages

Common Pages

Login/Register Page

1. Secure and Fast

2. Uses JWT instead of session and cookies for persistent auth state.

   (Removing the overhead caused by storing sessions on the server)

   

Profile Page

1. View all your details here.
2. Logout here.

Customer Pages

Create-Order Page

1. Create orders by selecting print details like page size, color, and PDF on this page.
2. Click NEXT to proceed to the Checkout page for payment and order completion.

Order-Dashboard Page

1. View all order history here.
2. Filter orders by status: ORDER PENDING, ORDER PREPARED/PRINTED, or ORDER PICKED.
3. Pagination is enabled for long order lists.

Shop-Owner Pages

Owner Order-Dashboard Page

1. Similar to the Customer Order Dashboard.
2. View all order history here.
3. Filter orders by status: ORDER PENDING, ORDER PREPARED/PRINTED, or ORDER PICKED.
4. Pagination is enabled for long order lists.
5. Click any order tile to change its status and notify the customer.

Update Order Status Page

1. Order Status can be changed on this page.

Tech Stack ⚛️

Frontend

1. React Native
2. Expo
3. Javascript

Backend

1. ExpressJS
2. Typescript
3. MySQL
4. Prisma ORM

5. Deployment

   Vercel (for development and testing)
   AWS/other VPS (for production)
   

How to setup? 💻

1. Setup all the environment vars in the .env file taking inspiration from the .env.example file
2. Setup the mysql server locally.
3. Make sure that the env var "BLOB_READ_WRITE_TOKEN" is not set when running the server locally. It will only be used when deploying on vercel.

After that do,

npm i
prisma generate
prisma db push
npm run dev

Test Credentials 🔑

User Type	Email	Pass
Shop Owner	[email protected]	test
Customer	[email protected]	test

Useful Links & Credits ➕

Frontend is deployed here Printease Web

Link for the frontend codebase - PrintEase-UI

(Credits: Aman Siddiqui)