Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 3.97 KB

README.md

File metadata and controls

95 lines (61 loc) · 3.97 KB

🍔 Food Orders

Modern e-commerce self-hosted platform: clients will be happy to order delicious food!

👉 Check out demo website

🎯 Admin panel. Use demo as login and password. Read mode only.

main-screen-desktop

🍕 Main idea and architecture of Next-Orders

There is a great desire to create software that is ideal for ordering and delivering food. It will be a set of solutions that can work together. It is important that each element can be easily replaced later. So the project does not become one big monolith.

next-orders-arch

I'm currently working on the first version of the website. Next year there will be a new version that will easily replace the old one as the Main API with business logic will remain the same.

Let's see what happens. Give the project a star ⭐. Offer your ideas and make commits.

🍣 Customer and Seller Features (WIP)

  • 📱 100% adaptive layout
  • 🤹 Multi-page structure with priority on fast page loading and SEO
  • 🛒 The cart is always in sight on desktop
  • 🚚 Possibility to choose delivery or pickup
  • 🔍 Quick search in the product catalog
  • 🏷️ The client can use a promotional code
  • 📈 The best offers and promotions are shown in the desired section
  • 🏁 Quick order, without forced registration on the site

🥪 Tech Features (WIP)

  • Website has its own backend, where API data does not break out
  • Most of the code is rendered on the server: less load on the client

Check out PageSpeed Insights. Maybe it's showing all 100s 😉

🌎 Locales

The application has several localizations:

  • en | English
  • ru | Russian | Русский
  • ka | Georgian | ქართული

🥒 Repository structure

  • Food e-commerce: Storefront and Command Center. Client can order delicious food.
  • Email service: Easy way to build and send html emails through a prepared service.

☕ How to deploy

⚠️ Warn: work in progress. Be careful with updates! Your images and DB data are at risk.

You can deploy @next-orders/food on your server (1GB+ RAM) by this:

# Connect over SSH and use with args: version, locale, your domain, your email
curl -fsSL https://nextorders.space/food/install.sh | bash -s -- "v0.7.0" "en" "test.nextorders.space" "[email protected]"

# It will install Docker, Docker Compose and download latest docker-compose.yaml
# After, it will bring up Traefik to serve web requests, create and autoupdate SSL certificate
# Food app, DB, migrations... You are ready to check your domain!

Also, you can use single Docker Image to create container:

# Use the specific version
docker pull ghcr.io/next-orders/food:v0.7.0

# Warn: you need an external PostgreSQL as DB

Check .env.example for more info about required config variables.

🍿 How to develop

You can develop in isolated container with prepared options:

Open in Dev Containers

Make a fork. Or clone this repo and use standard commands:

git clone https://github.com/next-orders/food
pnpm i
pnpm dev:food

🍰 License

This project is licensed under the MIT License - see the MIT License file for details.