Skip to content

Commit bde2f2a

Browse files
authored
Merge pull request #252 from HOSTED-POWER/BjarneVO-KBrestructure
Bjarne vo k brestructure
2 parents 6a0518f + 64a2d21 commit bde2f2a

10 files changed

Lines changed: 46 additions & 40 deletions

File tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
label: MedusaJS
1+
label: Medusa.js
22
order: 80
33
icon: apps
44
expanded: false
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
**Medusa.js** is an open-source, headless eCommerce platform built in JavaScript and Node.js, designed to give developers and merchants a highly flexible, API-first foundation for building custom online commerce experiences. It features a modular architecture with composable commerce modules for products, carts, orders, inventory, discounts, multi-region/currency support and more, plus a customizable admin dashboard and APIs that let you build your storefront with any frontend framework. Whether you’re launching a simple store, a complex marketplace, or a global B2B/B2C platform, Medusa.js provides the extensibility and developer control to design tailored eCommerce solutions suited to modern headless workflows.
2+
3+
### Overview:
4+
* [Medusa.js Reference Guide](referenceguide.md)
5+
### How-To Guides
6+
* [Medusa.js Setup Example](setupexample.md)

Technologies/CMS & Frameworks/MedusaJS/referenceguide.md renamed to Technologies/CMS & Frameworks/Medusa.js/referenceguide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
hidden: true
33
---
4-
# MedusaJS Hosting Reference Guide
5-
Our TurboStack is equiped to handle your optimized MedusaJS application!
4+
# Medusa.js Hosting Reference Guide
5+
Our TurboStack is equipped to handle your optimized MedusaJS application!
66

77
We maintain the server and infrastructure, but MedusaJS configuration, themes, plugins, and customizations are your responsibility.
88

99
This guide will inform you about the filestructure, permissions, caching and more, of your MedusaJS application.
1010

1111
## File Structure
1212

13-
The following table shows the directory structure of a MedusaJS application:
13+
The following table shows the directory structure of a Medusa.js application:
1414

1515
| Path | Purpose |
1616
|----------------------|---------|
@@ -42,7 +42,7 @@ chown -R $USER:$USER ~/<Project>/<Shopname>
4242
You can find our documentation on how to set up Redis [here](../../Caching/redis.md)
4343

4444
### Varnish
45-
The MedusaJS dashboard does not need any caching. We do recommend adding varnish to your storefront.
45+
The Medusa.js dashboard does not need any caching. We do recommend adding varnish to your storefront.
4646

4747
You can enable Varnish in our TurboStack GUI by adding the following line to the YAML configuration, for the `vhost` where your frontend resides.
4848

Technologies/CMS & Frameworks/MedusaJS/setupexample.md renamed to Technologies/CMS & Frameworks/Medusa.js/setupexample.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
hidden: true
33
---
44
# Setup example on TurboStack
5-
In this example, we will set up a MedusaJS instance on TurboStack. This will include the demo frontend and the MedusaJS backend.
5+
In this example, we will set up a Medusa.js instance on TurboStack. This will include the demo frontend and the Medusa.js backend.
66

7-
If you only want to set up the backend, you can choose this in project creation later. MedusaJS exposes API's for you to _'Plug in'_ your own frontend.
7+
If you only want to set up the backend, you can choose this in project creation later. MedusaJS exposes APIs for you to _'Plug in'_ your own frontend.
88
## YAML configuration
99
MedusaJS requires:
10-
- NodeJS 20+ (LTS versions only)
10+
- Node.js 20+ (LTS versions only)
1111
- PostgreSQL
1212

1313
The dashboard (backend) runs on port 9000/app and the demo frontend runs on port 8000.
@@ -39,7 +39,7 @@ system_users:
3939
## Server setup
4040
4141
### Creating the project
42-
After the deploy succeeded, we can start setting up the server. We will use generic names, for this example. You can change these to your own.
42+
After the deployment succeeded, we can start setting up the server. We will use generic names, for this example. You can change these to your own.
4343
4444
Make a new project directory and navigate to it:
4545
```bash
@@ -48,11 +48,11 @@ cd project
4848
```
4949
> **Important:** You don't want to place this in the `public_html` directory, as it will expose sensitive files to the public.
5050
51-
To create a MedusaJS project, run the following command:
51+
To create a Medusa.js project, run the following command:
5252
```bash
5353
npx create-medusa-app@latest <shopname>
5454
```
55-
This will start the interactive install process. Follow the prompts to complete the installation:
55+
This will start the interactive installation process. Follow the prompts to complete the installation:
5656
```
5757
? Would you like to install the Next.js Starter Storefront? You can also install it later. Yes
5858
? Enter your Postgres username demo_db
@@ -180,8 +180,8 @@ pm2 start "npm start" --name storefront
180180
## Tips
181181
### Automating the deployment process
182182
If you want to automate the deployment process, you can do two things:
183-
- Include the database connectionstring in the create-medusa-app command
184-
- use the `--with-nextjs-starter` flag to include the storefront, then delete it after the install.
183+
- Include the database connection string in the create-medusa-app command
184+
- use the `--with-nextjs-starter` flag to include the storefront, then delete it after the installation.
185185
- Grab the Postgres credentials on the server, instead of the TurboStack GUI.
186186

187187
To get the Postgres credentials, run the following command in the home directory of the user:
@@ -194,5 +194,5 @@ The command should look like this:
194194
npx create-medusa-app@latest shopname --db-url "postgres://<username>:<password>@localhost:5432/<dbname>" --with-nextjs-starter
195195
```
196196

197-
After the install, delete the storefront directory.
197+
After the installation, delete the storefront directory.
198198
---

Technologies/CMS & Frameworks/MedusaJS/readme.md

Lines changed: 0 additions & 6 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
label: NodeJS
1+
label: Node.js
22
order: 70
33
icon: apps
44
expanded: false

Technologies/CMS & Frameworks/NodeJS/pm2.md renamed to Technologies/CMS & Frameworks/Node.js/pm2.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1+
---
2+
hidden: true
3+
---
14
## Overview
25

36
In this article we will be going over handy how-to commands in configuring, deploying and troubleshooting your PM2 application.
4-
PM2 is a process manager for NodeJS applications, it comes with many benefits with the overall benefit being it making sure your application runs continuously and is easily manageable.
7+
PM2 is a process manager for Node.js applications, it comes with many benefits with the overall benefit being it making sure your application runs continuously and is easily manageable.
58

69
Benefits include:
710
- Keeps the application running due to auto-restarts
@@ -12,16 +15,16 @@ Benefits include:
1215

1316
## Installation
1417

15-
When defining NodeJS in your deployment in my.turbostack.app pm2 will be installed by default by your node package manager :
18+
When defining Node.js in your deployment in my.turbostack.app pm2 will be installed by default by your node package manager :
1619

1720
<img width="1000" height="713" alt="image" src="https://github.com/user-attachments/assets/ac652f6a-1a9e-4824-8764-e0904a605b39" />
1821

1922
## Deploying the application
20-
1. In case you migrated from another environment and you want to start with a fresh deployment, make sure to clean out the node_modules directory:
23+
1. In case you migrated from another environment, and you want to start with a fresh deployment, make sure to clean out the node_modules directory:
2124

2225
`rm -rf node_modules`
2326

24-
It could be that during migration somethig is missing/corrupted/incompatible. Removing the directory ensures a flawless reinstall.
27+
It could be that during migration something is missing/corrupted/incompatible. Removing the directory ensures a flawless reinstall.
2528

2629
2. Check the important configuration files are present and changed accordingly if needed ( `next.config.js` and `package.json`)
2730

@@ -41,13 +44,13 @@ When defining NodeJS in your deployment in my.turbostack.app pm2 will be install
4144

4245
`pm2 save`
4346

44-
> This will store the **current** process list so the application can be restarted automatically after a reboot of the server or any other disturbance causing the service to stop. **Always do this whenever the running process list changes** ( e.g when deleting/starting a new application, changing the app name, et citera...)
47+
> This will store the **current** process list so the application can be restarted automatically after a reboot of the server or any other disturbance causing the service to stop. **Always do this whenever the running process list changes** (e.g. when deleting/starting a new application, changing the app name, etcetera...)
4548
4649
7.**If this is the first time setup** it could be that you need to run:
4750

4851
`pm2 startup`
4952

50-
This prepares pm2 to launch on system boot, afterwards `pm2 save` will handle all running operations.
53+
This prepares pm2 to launch on system boot, afterwards, `pm2 save` will handle all running operations.
5154

5255
## Monitoring and troubleshooting the application
5356

@@ -78,7 +81,7 @@ When defining NodeJS in your deployment in my.turbostack.app pm2 will be install
7881
* `--err` : show only errors
7982
* `--out` : show only output
8083

81-
- Restart or reload an applicaiton:
84+
- Restart or reload an application:
8285

8386
`pm2 restart <appname>`
8487

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
**Node.js** is an open-source, cross-platform Javascript runtime environment.
2+
Traditionally Javascript is used to make websites interactive within the browser.
3+
Node.js is a way to let you use JavaScript outside of a web browser and instead use it on the server itself.
4+
5+
### Overview:
6+
7+
* [Node.js Reference Guide](referenceguide.md)
8+
9+
### How-To Guides
10+
11+
* [PM2 - Process manager for Node.js applications ](pm2.md)

Technologies/CMS & Frameworks/NodeJS/referenceguide.md renamed to Technologies/CMS & Frameworks/Node.js/referenceguide.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
---
2+
hidden: true
3+
---
14
# Node.js Hosting Reference Guide
25

3-
We provide optimized server environments for running **Node.js applications**. As the hosting provider, we maintain the server infrastructure, network, and runtime environment. Application code, dependencies, environment variables, and process management within your project areyour responsibility. (but we are always happy to assist when you are encountering issue ofcourse)
6+
We provide optimized server environments for running **Node.js applications**. As the hosting provider, we maintain the server infrastructure, network, and runtime environment. Application code, dependencies, environment variables, and process management within your project are your responsibility. (but we are always happy to assist when you are encountering issue ofcourse)
47

58
This guide outlines the typical file structure and recommended permissions for your application.
69

Technologies/CMS & Frameworks/NodeJS/readme.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)