Skip to content
This repository has been archived by the owner on Jan 23, 2024. It is now read-only.
/ trishop Public archive

Fullstack e-commerce for personal online shop with customer and admin dashboard πŸ›’

License

Notifications You must be signed in to change notification settings

rifandani/trishop

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Open Source E-Commerce Platform

roompy - discord chat by serverId trishop - status active trishop - license mit

Commitizen friendly Cypress Test


DeepScan grade

What is Trishop ❓

Trishop is a free and open-source e-commerce platform for business units who want to find customers and sell their own products online. This platform is different from platforms such as Shopee, Tokopedia or the like which use a multi-role user system where users can register as buyers and sellers at the same time. This platform is meant for only one seller.

What is inside ❓

Trishop equipped with features:

  1. Safe typed Next.js 12 (React 18) with Typescript + Eslint + Prettier best practices ⚑
  2. E2E testing with Cypress + Cypress workflows βœ…
  3. UI components documentation with Storybook and deployed to Chromatic 🌸
  4. Database using MongoDB and Mongoose ODM πŸƒ
  5. File storage using Cloudinary πŸ’Ύ
  6. Authentication using JWT inside of cookie πŸ”‘
  7. Role-based authorisation: [USER, ADMIN] for now πŸ”
  8. Form validation with Formik and Yup ✨
  9. Customer cart and wishlist with React Context (to be replaced by redux) πŸ› 
  10. Custom API routes middleware validation 🎊
  11. Review product ⭐
  12. Report product reviews for review that indicated as spam / inappropriate words 🚫
  13. Product coupon code πŸ‘©β€πŸ’»
  14. Customer dashboard to monitor orders that have been purchased (COMING SOON) πŸ•΅οΈβ€β™€οΈ
  15. Admin dashboard, includes CRUD for User, Product, Coupon, Report (monitor customer orders status, charts - COMING SOON) πŸ’Ž
  16. SEO-friendly 🌎
  17. and much more...

Services πŸ‘œ

Service Description
vercel Next.js Hosting
cloudinary File Storage Solution
mongodb NoSQL Database
chromatic Storybook Hosting
cypress E2E Testing
midtrans Payment Gateway (coming soon)

Branches πŸ”±

  • develop -> Pull Request to this branch for contribution
  • main -> Don't touch, production branch

Screenshots πŸ“·

Show me some demo images!
  • Products page

    products page
  • Product detail page

    product detail page
  • Cart page

    cart page
  • Checkout page

    checkout page
  • Admin dashboard page

    admin dashboard page
  • Admin dashboard - add product page

    admin dashboard add product page

How to use πŸ€

To run this project locally, follow these simple steps:

  1. Clone repo
  2. Run yarn install or npm install
  3. Run yarn dev or npm run dev to run Next.js frontend and backend in port 3000

Notes:

  1. Backend API is in /pages/api/v1 folder
  2. Run yarn storybook to run Storybook in port 6006

Contributing 🧩

Trishop web is open for contributions, whether it's a contribution to project functionality or in the form of documentation. I recommend you start by creating a new issue or join the Discord community so I can know in advance what you want to add/work on so that the project can be more coordinated and what we are working on will not collide with each other.

Please read CONTRIBUTING.md to know more about the details. (NOT YET UPDATED - IF YOU WANT TO BE A CONTRIBUTORS PLEASE LET ME KNOW IN DISCORD)

Code of Conduct πŸ“

Made with the aim that all participants or contributors in this project are free from all forms of discrimination, humiliation, threats, violence, or the like.

Please read CODE_OF_CONDUCT.md to know more about the details.

Change Log πŸ“œ

Used for tracking minor, major updates and breaking changes to projects.

Please read CHANGELOG.md to know more about the details.

License πŸ“„

MIT