MangoPig
81 lines
1.8 KiB
Markdown
81 lines
1.8 KiB
Markdown
# Royal Pop Accessory
|
|
|
|
<img src="Store/public/favicon/android-chrome-192x192.png" alt="Royal Pop Accessory Logo" width="160" />
|
|
|
|
## Description
|
|
|
|
Royal Pop Accessory is a storefront and lightweight operations stack for a watch strap accessory product line. It has a modern Apple inspired design that will make your product stand out amongst the competitors.
|
|
|
|
## Installation
|
|
|
|
Before running the project, make sure you have the following installed:
|
|
|
|
- [Git](https://git-scm.com/)
|
|
- [Docker](https://www.docker.com/)
|
|
- [Docker Compose](https://docs.docker.com/compose/)
|
|
- [`just`](https://github.com/casey/just#installation)
|
|
|
|
Optional for local Stripe webhook development:
|
|
|
|
- [Stripe CLI](https://docs.stripe.com/stripe-cli)
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://git.mangopig.tech/Goko/Royal-Pop-Accessory.git
|
|
|
|
# Go into the repository
|
|
cd Royal-Pop-Accessory
|
|
|
|
# Copy the example environment file
|
|
cp Env/.env.example Env/.env.local
|
|
|
|
# Review available commands
|
|
just help
|
|
|
|
# Start the local development stack
|
|
just local dev
|
|
```
|
|
|
|
## Usage
|
|
|
|
1. **Local development**
|
|
|
|
```bash
|
|
just local dev
|
|
```
|
|
|
|
2. **Listen for Stripe webhooks during development**
|
|
|
|
```bash
|
|
just local dev stripe listen
|
|
```
|
|
|
|
3. **Run the local production-style stack**
|
|
|
|
```bash
|
|
just local prod
|
|
```
|
|
|
|
4. **Run the registry-backed production-style stack locally**
|
|
|
|
```bash
|
|
just remote prod up
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
- `Store/` — Astro storefront
|
|
- `Backend/` — Go API
|
|
- `Proxy/` — production proxy image and config
|
|
- `Docker/` — compose files
|
|
- `Commands/` — `just` command modules
|
|
- `Env/` — local environment files and examples
|
|
|
|
## License
|
|
|
|
GNU General Public License v3.0. See [LICENSE](LICENSE) for details.
|
|
|
|
## Support
|
|
|
|
If you'd like a custom storefront or a similar ecommerce build, please contact Ronald at [ronald@goko.solutions](mailto:ronald@goko.solutions).
|