Skip to content

Commit 373d544

Browse files
authored
Merge pull request #16 from dacharyc/add-readmes
Add READMEs to development
2 parents 2fa5ea0 + 9f99a28 commit 373d544

File tree

3 files changed

+78
-0
lines changed

3 files changed

+78
-0
lines changed

mflix/README-JAVA-SPRING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Java Spring Boot MongoDB Sample MFlix Application
2+
3+
[TODO: Add intro]
4+
5+
```
6+
├── README.md
7+
├── client/ # Next.js frontend
8+
└── server/ # Java Spring backend
9+
```
10+
11+
## Getting Started
12+
13+
[TODO: Add getting started instructions explaining how to set connection string, start server, start client, etc.]
14+
15+
## Issues
16+
17+
If you have problems running the sample app, please check the following:
18+
19+
- [ ] Verify that you have set your MongoDB connection string in the `.env` file.
20+
- [ ] Verify that you have started the Java Spring server.
21+
- [ ] Verify that you have started the Next.js client.
22+
- [ ] Verify that you have no firewalls blocking access to the server or client ports.
23+
24+
If you have verified the above and still have issues, please
25+
[open an issue](https://github.com/mongodb/docs-sample-apps/issues/new/choose)
26+
on the source repository `mongodb/docs-sample-apps`.

mflix/README-JAVASCRIPT-EXPRESS.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# JavaScript Express.js MongoDB Sample MFlix Application
2+
3+
[TODO: Add intro]
4+
5+
```
6+
├── README.md
7+
├── client/ # Next.js frontend
8+
└── server/ # Express.js backend
9+
```
10+
11+
## Getting Started
12+
13+
[TODO: Add getting started instructions explaining how to set connection string, start server, start client, etc.]
14+
15+
## Issues
16+
17+
If you have problems running the sample app, please check the following:
18+
19+
- [ ] Verify that you have set your MongoDB connection string in the `.env` file.
20+
- [ ] Verify that you have started the Express server.
21+
- [ ] Verify that you have started the Next.js client.
22+
- [ ] Verify that you have no firewalls blocking access to the server or client ports.
23+
24+
If you have verified the above and still have issues, please
25+
[open an issue](https://github.com/mongodb/docs-sample-apps/issues/new/choose)
26+
on the source repository `mongodb/docs-sample-apps`.

mflix/README-PYTHON-FASTAPI.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Python FastAPI MongoDB Sample MFlix Application
2+
3+
[TODO: Add intro]
4+
5+
```
6+
├── README.md
7+
├── client/ # Next.js frontend
8+
└── server/ # Python FastAPI backend
9+
```
10+
11+
## Getting Started
12+
13+
[TODO: Add getting started instructions explaining how to set connection string, start server, start client, etc.]
14+
15+
## Issues
16+
17+
If you have problems running the sample app, please check the following:
18+
19+
- [ ] Verify that you have set your MongoDB connection string in the `.env` file.
20+
- [ ] Verify that you have started the Python FastAPI server.
21+
- [ ] Verify that you have started the Next.js client.
22+
- [ ] Verify that you have no firewalls blocking access to the server or client ports.
23+
24+
If you have verified the above and still have issues, please
25+
[open an issue](https://github.com/mongodb/docs-sample-apps/issues/new/choose)
26+
on the source repository `mongodb/docs-sample-apps`.

0 commit comments

Comments
 (0)