Trishop

Open Source E-Commerce Platform

📢 Discord Contributors Community 📢

---

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

  

• Product detail page

  

• Cart page

  

• Checkout page

  

• Admin dashboard 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
4. 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