Skip to content

Commit 69b1bed

Browse files
XjectroXjectro
authored
Update README.md
1 parent 73418c4 commit 69b1bed

File tree

1 file changed

+91
-95
lines changed

1 file changed

+91
-95
lines changed

‎README.md‎

Lines changed: 91 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,125 +1,121 @@
1-
<p align="center">
2-
<a href="https://www.medusajs.com">
3-
<picture>
4-
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/59018053/229103275-b5e482bb-4601-46e6-8142-244f531cebdb.svg">
5-
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
6-
<img alt="Medusa logo" src="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
7-
</picture>
8-
</a>
9-
</p>
10-
11-
<h1 align="center">
12-
Medusa Next.js Starter Template
13-
</h1>
14-
15-
<p align="center">
16-
Combine Medusa's modules for your commerce backend with the newest Next.js 15 features for a performant storefront.</p>
17-
18-
<p align="center">
19-
<a href="https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md">
20-
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs welcome!" />
21-
</a>
22-
<a href="https://discord.gg/xpCwq3Kfn8">
23-
<img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg" alt="Discord Chat" />
24-
</a>
25-
<a href="https://twitter.com/intent/follow?screen_name=medusajs">
26-
<img src="https://img.shields.io/twitter/follow/medusajs.svg?label=Follow%20@medusajs" alt="Follow @medusajs" />
27-
</a>
28-
</p>
29-
30-
### Prerequisites
31-
32-
To use the [Next.js Starter Template](https://medusajs.com/nextjs-commerce/), you should have a Medusa server running locally on port 9000.
33-
For a quick setup, run:
34-
35-
```shell
36-
npx create-medusa-app@latest
37-
```
1+
# 🐍 Medusa.js Restored Frontend - The Phoenix of E-commerce!
382

39-
Check out [create-medusa-app docs](https://docs.medusajs.com/learn/installation) for more details and troubleshooting.
3+
*Like the mythical creature, this frontend has been reborn from the ashes... but instead of turning people to stone, it turns visitors into customers!*
404

41-
# Overview
5+
## 🎭 What's This All About?
426

43-
The Medusa Next.js Starter is built with:
7+
Welcome to the **Medusa.js Restored Frontend** - a sleek, modern e-commerce storefront that combines the power of Medusa's headless commerce backend with the blazing-fast Next.js 15! Think of it as the Swiss Army knife of online stores, but shinier and with better TypeScript support.
448

45-
- [Next.js](https://nextjs.org/)
46-
- [Tailwind CSS](https://tailwindcss.com/)
47-
- [Typescript](https://www.typescriptlang.org/)
48-
- [Medusa](https://medusajs.com/)
9+
## ✨ Features That'll Make You Go "Whoa!"
4910

50-
Features include:
11+
### 🛍️ **Full E-commerce Arsenal**
12+
- **Product Detail Pages** - Because first impressions matter (and so do the second, third, and fourth ones)
13+
- **Product Overview Pages** - Where window shopping gets an upgrade
14+
- **Product Collections** - Like Netflix categories, but for things you can actually touch
15+
- **Shopping Cart** - The digital equivalent of "hold my beer"
16+
- **Stripe Checkout** - Money talks, and we speak fluent credit card
17+
- **User Accounts** - Your customers' digital home away from home
18+
- **Order Details** - Receipts that don't fade in your pocket
5119

52-
- Full ecommerce support:
53-
- Product Detail Page
54-
- Product Overview Page
55-
- Product Collections
56-
- Cart
57-
- Checkout with Stripe
58-
- User Accounts
59-
- Order Details
60-
- Full Next.js 15 support:
61-
- App Router
62-
- Next fetching/caching
63-
- Server Components
64-
- Server Actions
65-
- Streaming
66-
- Static Pre-Rendering
20+
### 🚀 **Next.js 15 Superpowers**
21+
- **App Router** - Navigation so smooth, it's practically butter
22+
- **Server Components** - Faster than your morning coffee kicks in
23+
- **Server Actions** - Like regular actions, but with a cape
24+
- **Streaming** - Not the Netflix kind, the "ridiculously fast loading" kind
25+
- **Static Pre-Rendering** - Pages that load before you even click them (almost)
6726

68-
# Quickstart
27+
## 🎪 Quick Setup - The "I Want It Now" Edition
6928

70-
### Setting up the environment variables
29+
### Prerequisites (The Boring But Important Stuff)
30+
- Node.js (the newer, the better - we don't judge vintage though)
31+
- Yarn (because npm is so last Tuesday)
32+
- A Medusa backend running on port 9000 (like a well-behaved server should)
7133

72-
Navigate into your projects directory and get your environment variables ready:
34+
### The Magic Spell (Installation)
7335

74-
```shell
75-
cd nextjs-starter-medusa/
76-
mv .env.template .env.local
77-
```
36+
1. **Summon your Medusa backend:**
37+
```bash
38+
npx create-medusa-app@latest
39+
```
40+
*This creates your backend faster than you can say "headless commerce"*
7841

79-
### Install dependencies
42+
2. **Clone this beauty:**
43+
```bash
44+
git clone https://github.com/Xjectro/medusajs-restored-frontend
45+
cd medusajs-restored-frontend
46+
```
8047

81-
Use Yarn to install all dependencies.
48+
3. **Environment variables dance:**
49+
```bash
50+
mv .env.template .env.local
51+
```
52+
*Don't forget to fill in your actual values - lorem ipsum won't pay the bills*
8253

83-
```shell
84-
yarn
85-
```
54+
4. **Install dependencies (the fun part):**
55+
```bash
56+
yarn install
57+
```
58+
*Time to grab a coffee while the internet downloads itself*
59+
60+
5. **Launch into orbit:**
61+
```bash
62+
yarn dev
63+
```
64+
*Your store is now live at [http://localhost:8000](http://localhost:8000) - prepare for takeoff! 🚀*
65+
66+
## 💳 Payment Integration - Show Me The Money!
8667

87-
### Start developing
68+
### Stripe Setup (Because Everyone Loves Getting Paid)
8869

89-
You are now ready to start up your project.
70+
Add this magical incantation to your `.env.local`:
9071

91-
```shell
92-
yarn dev
72+
```env
73+
NEXT_PUBLIC_STRIPE_KEY=your-stripe-public-key-goes-here
9374
```
9475

95-
### Open the code and start customizing
76+
*Remember: With great payment power comes great responsibility (and hopefully great revenue)*
9677

97-
Your site is now running at http://localhost:8000!
78+
## 🏗️ Tech Stack - The Dream Team
9879

99-
# Payment integrations
80+
- **Next.js 15** - The React framework that makes developers happy
81+
- **Medusa.js** - Headless commerce that doesn't lose its head
82+
- **TypeScript** - JavaScript's smarter, more organized sibling
83+
- **Tailwind CSS** - Making things pretty without the CSS headaches
84+
- **Stripe** - Turning "I want this" into "Payment successful"
10085

101-
By default this starter supports the following payment integrations
86+
## 🎨 What Makes This Special?
10287

103-
- [Stripe](https://stripe.com/)
88+
This isn't just another e-commerce template - it's a **restored** frontend that brings together the best of modern web development:
10489

105-
To enable the integrations you need to add the following to your `.env.local` file:
90+
- **Performance** - Loads faster than your customer's patience runs out
91+
- **Scalability** - Grows with your business (and your ambitions)
92+
- **Developer Experience** - Because happy developers make better products
93+
- **Modern Architecture** - Built for 2024 and beyond, not 2004
10694

107-
```shell
108-
NEXT_PUBLIC_STRIPE_KEY=<your-stripe-public-key>
109-
```
95+
## 🤝 Contributing
96+
97+
Found a bug? Have an idea? Want to make this even more awesome?
98+
99+
1. Fork it (the repo, not the road)
100+
2. Create your feature branch (`git checkout -b feature/amazing-new-thing`)
101+
3. Commit your changes (`git commit -m 'Add some amazing new thing'`)
102+
4. Push to the branch (`git push origin feature/amazing-new-thing`)
103+
5. Open a Pull Request and let's make magic happen!
104+
105+
## 📖 Documentation & Resources
106+
107+
- [Medusa.js Documentation](https://docs.medusajs.com) - Your best friend for backend mysteries
108+
- [Next.js Documentation](https://nextjs.org/docs) - Everything you need to know about the frontend magic
109+
- [Stripe Documentation](https://stripe.com/docs) - The money-handling manual
110110

111-
You'll also need to setup the integrations in your Medusa server. See the [Medusa documentation](https://docs.medusajs.com) for more information on how to configure [Stripe](https://docs.medusajs.com/resources/commerce-modules/payment/payment-provider/stripe#main).
111+
## 🎉 Final Words
112112

113-
# Resources
113+
Remember: E-commerce is not just about selling products - it's about creating experiences. This frontend helps you create experiences so smooth, your customers will think they're shopping in the future!
114114

115-
## Learn more about Medusa
115+
Now go forth and build something amazing! 🚀
116116

117-
- [Website](https://www.medusajs.com/)
118-
- [GitHub](https://github.com/medusajs)
119-
- [Documentation](https://docs.medusajs.com/)
117+
---
120118

121-
## Learn more about Next.js
119+
*Made with ❤️, ☕, and probably too much TypeScript*
122120

123-
- [Website](https://nextjs.org/)
124-
- [GitHub](https://github.com/vercel/next.js)
125-
- [Documentation](https://nextjs.org/docs)
121+
**P.S.** - If you make millions using this, we won't say no to a coffee donation! ☕💰

0 commit comments

Comments
 (0)