Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 2.65 KB

README.md

File metadata and controls

86 lines (56 loc) · 2.65 KB
Raw

mayoor

Modern order management system built with the latest tech stack.

Whats included? 🚀

  • orders + customers CRUD
    • forms, lists
    • validations
  • frontend localization
  • deployment setup

Tech stack

  • TypeScript
  • React
  • GraphQL
  • Prisma (v3)
  • NexusJS
  • Apollo Micro Server (serverless)
  • Apollo Client
  • Formik
  • styled-components
  • Ant Design
  • ESLint, Prettier

Live app demo

🌍 Visit http://mayoor.vercel.app/ - and log in with username: admin, password: admin

Requirements

  • installed Node.js v20 (includes NPM)
  • basic knowledge of Git
  • MongoDB url (recommended hosting on MongoDB Atlas - free tier is enough)

Getting started

Clone this repository:

git clone https://github.com/rostaklein/mayoor

  1. Install dependencies npm i post install hook will make sure it generates all the necessary types - Prisma and Nexus for backend development + Apollo (graphql-codegen) for FE development

  2. Edit environment variables

  • copy .env.example into .env and prisma/.env.example into prisma/.env
  • fill in with requried info (client secret nad prisma DB url - you can host MongoDB on your own, but strongly recommended to use the hosted Atlas version)

  1. Run locally via npm run dev

  2. Done. Profit 🎉

Deployment

  • this app is ready to be deployed immediately to Vercel
  • GraphQL server works via serverless functions
  • just link your GitHub repo with Vercel and let them do all the necessary stuff (dont forget to add environment variables via Vercel project settings)

Why does it exist?

The main motivation is to provide a codebase for an order management system that you can build on top of.

This project was built with a main focus as a support software for a company that prints PVC banners etc. Thats the reason why you might find some business specific pieces of code. The company is based in Czechia 🇨🇿, thats also the reason why the default currency is CZK and there are Czech translations.

Also this project is a result of my masters thesis on the University of Economics in 2020 👨‍🎓

Screenshots

mayoor - Add Customer mayoor - Add Order mayoor - List Orders

License

MIT

Rostislav Klein - mayoor - manage your orders - 2020