Skip to content

Commit 8b0b654

Browse files
authored
Update deploy to glitch guide (#592)
* Delete deploying-hyperdev-mlab.md * Add replacement glitch doc + update relative link in deploying.md
1 parent c36660d commit 8b0b654

File tree

4 files changed

+68
-65
lines changed

4 files changed

+68
-65
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
## Deploying to Glitch and mLab
2+
3+
Before you start, you'll need:
4+
5+
- mLab account (for free MongoDB)
6+
7+
### Step 1: Creating your database on mLab
8+
9+
[mLab](https://mlab.com) provides a Database-as-a-Service for MongoDB. They include a free tier for small sandbox databases. Create an account on mLab and then use the Single-node, Sandbox plan to get a (free) database up and running. Within the mLab wizard, you'll need to be sure to create a user that has access to connect to the new database. Upon completion, you should be able to construct a Mongo DB connection string like the following:
10+
11+
```
12+
mongodb://yourusername:[email protected]:yourdatabaseport/yourdatabasename
13+
```
14+
15+
### Step 2: Running parse-server-example on Glitch
16+
17+
[Glitch](https://glitch.com) provides an easy way to instantly create and deploy Node.js applications for free. We will use it to run the [parse-server-example](https://github.com/parse-community/parse-server-example) application.
18+
19+
To get the example server up and running for quick testing, you can simply click the button below:
20+
21+
[![Remix on Glitch](https://cdn.glitch.com/2703baf2-b643-4da7-ab91-7ee2a2d00b5b%2Fremix-button.svg)](https://glitch.com/edit/#!/import/github/parse-community/parse-server-example?APP_ID=myAppId&MASTER_KEY=your_master_key_here&DATABASE_URI=your_mlab_database_uri_here&SERVER_URL=https://project-name.glitch.me/parse&PARSE_SERVER_LOGS=/tmp)
22+
23+
Now that the import is complete, we'll need to make two small changes to the ```🗝️.env``` file, which stores private environment variables.
24+
25+
It should look like the following:
26+
27+
```
28+
# Environment Config
29+
30+
# store your secrets and config variables in here
31+
# only invited collaborators will be able to see your .env values
32+
33+
# reference these in your code with process.env.SECRET
34+
35+
SECRET=
36+
MADE_WITH=
37+
38+
# note: .env is a shell file so there can't be spaces around =
39+
APP_ID=myAppId
40+
MASTER_KEY=your_master_key_here
41+
DATABASE_URI=your_mlab_database_uri_here
42+
SERVER_URL=https://project-name.glitch.me/parse
43+
PARSE_SERVER_LOGS=/tmp
44+
45+
```
46+
First, change the ```DATABASE_URI``` value to your mLab connection string from step 1.
47+
48+
Next, change the ```project-name``` portion of the ```SERVER_URL``` value to the name of the project that was created. So, if clicking the button creates ```electric-dinner.glitch.me```, your ```SERVER_URL``` value would be ```https://electric-dinner.glitch.me/parse```.
49+
50+
You can delete the ```SECRET``` and ```MADE_WITH``` lines, but there's no harm in leaving them there.
51+
52+
It is important, for this tutorial, to leave the ```APP_ID``` as ```myAppId``` as the "test" page hard-codes that and expects that value.
53+
54+
If you'd like to keep this project, [create an account on Glitch](https://glitch.com/help/how-do-i-create-an-account-on-glitch/). Projects created as an anonymous user expire after five days. You can read more about the technical restrictions on free Glitch projects [here](https://glitch.com/help/restrictions/).
55+
56+
57+
### Step 3: Testing
58+
59+
Once you're finished making your changes to your ```🗝️.env``` file, Glitch will automatically build and deploy your application. If you use the Logs feature within Glitch (click on <kbd><kbd><samp>Tools</samp></kbd> &rarr; <kbd><samp>Logs</samp></kbd></kbd>), you should see this when your app is deployed:
60+
61+
```
62+
parse-server-example running on port 3000.
63+
```
64+
65+
You should then be able to use the "Show" button to launch the application in the browser and get to a page that urges you to star the parse-server GitHub repository. To access the test harness page, add a trailing ```/test``` to your URL. This should take you to a page that will allow you to exercise a few parts of the Parse Server Javascript SDK and create a dummy collection and record in your MongoDB. If you're able to complete steps one through three on this test page, Parse Server is up and running. Optionally, you can go back to mLab.com and take a look at the data that was stored by the test harness to get a feel for how Parse Server stores data in MongoDB.

_includes/parse-server/deploying-hyperdev-mlab.md

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

_includes/parse-server/deploying.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ The fastest and easiest way to start using Parse Server is to run MongoDB and Pa
44

55
{% include_relative _includes/parse-server/deploying-heroku-mlab.md %}
66

7-
{% include_relative _includes/parse-server/deploying-hyperdev-mlab.md %}
7+
{% include_relative _includes/parse-server/deploying-glitch-mlab.md %}

assets/js/bundle.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)