Skip to content

Commit f2d851f

Browse files
committed
Update instructions for local Atlas deployment
1 parent e27aa6b commit f2d851f

File tree

12 files changed

+70
-290
lines changed

12 files changed

+70
-290
lines changed

docs/20-mongodb-atlas/1-what-is-mongodb.mdx

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

docs/20-mongodb-atlas/2-create-account.mdx

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

docs/20-mongodb-atlas/3-create-cluster.mdx

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

docs/20-mongodb-atlas/_category_.json

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

docs/30-importing-data/1-intro.mdx

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

docs/30-importing-data/2-get-connection-string.mdx

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

docs/30-importing-data/3-import-data.mdx

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

docs/30-importing-data/_category_.json

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

docs/50-demo-app/2-start-app.mdx

Lines changed: 26 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,25 @@ import TabItem from '@theme/TabItem';
66

77
You have two options to start the application.
88

9-
## Option 1: Run in a codespace
9+
## Option 1: Run in Instruqt
1010

11-
By far, the easiest way to start the application is to run it in a codespace. A codespace is a cloud-hosted, containerized development environment that you can connect to from Visual Studio Code. It comes pre-configured with all the tools you need to build and run the application.
11+
Instruqt is a lab platform that provides cloud-based sandboxes which come pre-configured with all the tools you need to run this lab.
1212

13-
In the case of this application, you can even use the online IDE to edit the code and see the changes reflected in the running application.
13+
Navigate to the Instruqt lab using [this link](https://mdb.link/instruqt-library).
14+
15+
Fill out the form that appears and click **Submit and access**.
16+
17+
Click **Start** to launch the lab environment.
18+
19+
You should see a screen with a purple progress bar indicating that Instruqt is preparing a sandbox with all the required libraries for this lab and a MongoDB database.
20+
21+
Once this is done, you should see a **Start** button at the bottom right of the screen. Click this to enter the lab.
22+
23+
## Option 2: Run in a codespace
24+
25+
If Instruqt is not working for you, you can also use GitHub Codespaces. A GitHub Codespace is a cloud-hosted, containerized development environment that you can connect to from Visual Studio Code. It comes pre-configured with all the tools you need to build and run the application.
26+
27+
Similar to Instruqt, you can even use Codespaces as an online IDE to edit the code and see the changes reflected in the running application.
1428

1529
<Tabs groupId="server">
1630
<TabItem value="node" label="🚀 NodeJS/Express">
@@ -21,43 +35,21 @@ To start the application in a codespace, click "Code." Then, look for the *Codes
2135

2236
<Screenshot url="https://github.com/mongodb-developer/library-management-system" src="img/screenshots/50-demo-app/2-start-app/1-codespace.png" alt="Create codespace button" />
2337

24-
Let it run for a few seconds as it prepares your environment. It will clone the repository, prepare the containers, and run the installation scripts. Once it's ready, you'll see an IDE, with a preview window that shows the running application.
38+
Let it run for a few minutes as it prepares your environment. It will clone the repository, prepare the containers, and run the installation scripts. Once it's ready, you'll see an IDE, with a preview window that shows the running application.
2539

2640
:::note
2741
Again, this might take a few minutes. It's a great time to grab a coffee. ☕️
2842
:::
2943

30-
<Screenshot url="https://github.com/mongodb-developer/library-management-system" src="img/screenshots/50-demo-app/2-start-app/2-codespace.png" alt="The codespace" />
31-
32-
:::warning
33-
Right now, you should see a big error message in the console, as we haven't configured the app yet. Don't worry, you'll get it up and running in a few minutes.
34-
35-
```
36-
####### ###### ###### ####### ######
37-
# # # # # # # # #
38-
# # # # # # # # #
39-
##### ###### ###### # # ######
40-
# # # # # # # # #
41-
# # # # # # # # #
42-
####### # # # # ####### # #
43-
```
44-
:::
45-
46-
### Expose the server port
44+
### Access the library website
4745

48-
To get the application working in that environment, there is one small change you need to make to the codespace. You need to expose the port where the server is running.
46+
Once the environment loads, you may see the following warning:
4947

50-
Look for the *Ports* tab at the bottom of the IDE.
48+
<Screenshot url="https://github.com/mongodb-developer/library-management-system" src="img/screenshots/50-demo-app/2-start-app/7-visit-page.png" alt="A warning in the codespace saying 'You are about to access a development port served by someone's codespace'" />
5149

52-
<Screenshot url="https://github.com/mongodb-developer/library-management-system" src="img/screenshots/50-demo-app/2-start-app/3-ports.png" alt="The Ports tab" />
50+
You're seeing this warning because the development server is running on a publicly forwarded port, and GitHub shows a security notice anytime someone accesses a public port. Even in your own codespace, GitHub displays it just to confirm you intended to open that external-facing URL.
5351

54-
Once you click on the tab, you'll see a list of ports. Right-click on the port `Server (5000)` row. Then, select "Port Visibility" and "Public."
55-
56-
<Screenshot url="https://github.com/mongodb-developer/library-management-system" src="img/screenshots/50-demo-app/2-start-app/4-port-visibility.png" alt="The Port Visibility menu" />
57-
58-
You'll see the text in the *Visibility* column change to `Public`.
59-
60-
That's it! You're now ready to move to the next section.
52+
Click "Continue" to load the library application website. Once it loads, you're ready to move on to the next step.
6153

6254

6355
</TabItem>
@@ -119,13 +111,13 @@ That's it! You're now ready to move to the next section.
119111
</TabItem>
120112
</Tabs>
121113

122-
## 🦸 Option 2: Run locally
114+
## 🦸 Option 3: Run locally
123115

124-
If you prefer to run the application locally, you can do so by following these steps. Keep in mind that the following steps of this lab will be using the codespace, so you might need to adapt some of the commands.
116+
If you prefer to run the application locally, you can do so by following these steps. Keep in mind that the following steps of this lab will be using Instruqt or the GitHub codespace, so you might need to adapt some of the commands.
125117

126118
:::info
127119

128-
During the lab, we will use GitHub Codespaces. These instructions are here just in case you can't use Codespaces or you _really, really, really_ want a local installation.
120+
During the lab, we will use Instruqt or GitHub Codespaces. These instructions are here just in case you can't use Codespaces or you _really, really, really_ want a local installation.
129121

130122
:::
131123

0 commit comments

Comments
 (0)