diff --git a/.copier/config.yaml b/.copier/config.yaml index d9f108f..15b83b4 100644 --- a/.copier/config.yaml +++ b/.copier/config.yaml @@ -67,7 +67,7 @@ workflows: transformations: - move: { from: "mflix/client", to: "client" } - move: { from: "mflix/server/js-express", to: "server" } - - copy: { from: "mflix/README-JAVASCRIPT-EXPRESS.md", to: "README.md" } + - copy: { from: "mflix/README-NODE-EXPRESS.md", to: "README.md" } - copy: { from: "mflix/.gitignore-js", to: ".gitignore" } commit_strategy: pr_title: "Update MFlix application from docs-sample-apps" diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index bf7249c..d98787f 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -5,30 +5,38 @@ ## Sample App Information **Which sample app are you using?** + + - [ ] Java (Spring Boot) -- [ ] JavaScript (Express.js) +- [ ] Node (Express.js) - [ ] Python (FastAPI) ## Environment Details **MongoDB Database Version:** + **MongoDB Driver Version:** + **Deployment Type:** + + - [ ] Local MongoDB instance - [ ] MongoDB Atlas (cloud) - [ ] Docker container - [ ] Other (please specify): **Operating System:** + **Runtime Version:** + ## Steps to Reproduce @@ -73,4 +81,3 @@ Before submitting this issue, please confirm: - [ ] I have verified my MongoDB connection string is correct - [ ] I have installed all required dependencies - [ ] I have searched existing issues to avoid duplicates - diff --git a/README.md b/README.md index 506405f..1f44dc9 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ The sample app provides a Next.js frontend in the `client` directory, with the choice of three backend stacks in the `server` directory: - Java: Spring Boot -- JavaScript: Express.js +- Node.js: Express.js - Python: FastAPI ``` @@ -34,7 +34,7 @@ choice of three backend stacks in the `server` directory: This repository serves as the source for the following artifact repositories: - Java: [mongodb/sample-app-java-mflix](https://github.com/mongodb/sample-app-java-mflix) -- JavaScript: [mongodb/sample-app-nodejs-mflix](https://github.com/mongodb/sample-app-nodejs-mflix) +- Node.js: [mongodb/sample-app-nodejs-mflix](https://github.com/mongodb/sample-app-nodejs-mflix) - Python: [mongodb/sample-app-python-mflix](https://github.com/mongodb/sample-app-python-mflix) ## Development @@ -46,9 +46,9 @@ to a target repository for each sample app. For configuration details, refer to ### Branching Model For development, work from the `development` branch. Make incremental PRs -containing new features and bug fixes to `development`, *not* `main`. +containing new features and bug fixes to `development`, _not_ `main`. -When all development work is complete, *then* create a release PR from +When all development work is complete, _then_ create a release PR from `development` to `main`. Upon merging to `main,` the copier tool runs automatically. It creates a new PR in the target repository, which must be tested and merged manually. @@ -91,7 +91,7 @@ To test and verify the PR, navigate to the target repository - see - [ ] Run the tests - [ ] Run the application and verify that it functions as expected. - [ ] Review the `deprecated_examples.json` file for any files that need to be - deleted. If files are deleted: + deleted. If files are deleted: - [ ] Add a commit to the copier PR to delete the files from the target repository. - [ ] Merge the PR. @@ -100,7 +100,7 @@ To test and verify the PR, navigate to the target repository - see If you are a developer having issues with the sample app, feel free to open an issue in this repository. Please include the following information: -- [ ] The sample app you are using (Java, JavaScript, or Python) +- [ ] The sample app you are using (Java, Node.js, or Python) - [ ] The version of the MongoDB database you are using - [ ] The version of the MongoDB driver you are using - [ ] What type of deployment you're using (local, Atlas, etc.) diff --git a/mflix/README-JAVASCRIPT-EXPRESS.md b/mflix/README-NODE-EXPRESS.md similarity index 98% rename from mflix/README-JAVASCRIPT-EXPRESS.md rename to mflix/README-NODE-EXPRESS.md index f3c531c..4afd2ca 100644 --- a/mflix/README-JAVASCRIPT-EXPRESS.md +++ b/mflix/README-NODE-EXPRESS.md @@ -1,4 +1,4 @@ -# JavaScript Express.js MongoDB Sample MFlix Application +# Node Express.js MongoDB Sample MFlix Application This is a full-stack movie browsing application built with Express.js and Next.js, demonstrating MongoDB operations using the `sample_mflix` dataset. The application showcases CRUD operations, aggregations, and MongoDB Search using the native MongoDB Node.js driver. @@ -89,7 +89,6 @@ From the `server` directory, run: npm run dev ``` - Or for production mode, run: ```bash @@ -98,6 +97,7 @@ npm start ``` The server will start on `http://localhost:3001`. You can verify it's running by visiting: + - API root: http://localhost:3001/ - API documentation (Swagger UI): http://localhost:3001/api-docs @@ -126,6 +126,7 @@ The Next.js application will start on `http://localhost:3000`. ### 5. Access the Application Open your browser and navigate to: + - **Frontend:** http://localhost:3000 - **Backend API:** http://localhost:3001 - **API Documentation:** http://localhost:3001/api-docs @@ -147,6 +148,7 @@ Open your browser and navigate to: ### Backend Development The Express.js backend uses: + - **Express.js 5** for REST API - **MongoDB Node.js Driver** for database operations - **TypeScript** for type safety @@ -170,6 +172,7 @@ npm run test:coverage ### Frontend Development The Next.js frontend uses: + - **React 19** with TypeScript - **Next.js 16** with App Router - **Turbopack** for fast development builds @@ -196,6 +199,7 @@ npm start # Starts production server ``` The production build: + - Minifies and optimizes JavaScript and CSS - Optimizes images and assets - Generates static pages where possible