Migrated JSON Files to MongoDB. Abstracted Server functionality into MVC (Model & Controllers) #104

ssaryonjr · 2022-10-12T03:59:16Z

Summary:

Migrated entire JSON resources file into MongoDB. Abstracted server code and moved into MVC-style architecture for easier debugging and modularity. Utilized mongoose for form validations.
NOTE: Please continue from this PR and connect api/resources/getResources to input form inside views > index.ejs in order for resource fetching functionality to work again.

Dependencies

Express Async Handler
Mongoose
Dotenv

Server.js

Deleted API Endpoint for keyword input search.
Added MongoDB to server.js
Created .env file
Added errorHandler middleware to assist in status errors when testing in Postman.

Routes & Controllers

getResources - Migrated original functionality for resource query results from Mongo Database.
createResource - Custom API Endpoint for easily adding new resources to Mongo Database. (A view will be needed to be created later on for this to be done in the UI. Currently only available through Postman).
Routes - Abstracted API Endpoints into the routes folder. Created a search params /api/resources/:keyword for returning resource results.

Model

Implemented resource schema for easier form validation when adding new data to MongoDB.
name - String & Required.
url - String & Required.
description - String & Required
keywords - Creates an array from a string sentence. Example: ["JavaScript", "Git"]

Config

Store your .env file inside the config folder for easier organization. Please include: MONGO_URI and PORT

Middleware

Added errorHandler middleware to assist in status errors when testing in Postman.

Closing #94

added table of contents

Test -> Main Merge, Version 4

Test

Public folder

changed recieve to receive

Fix typo

change the heroku links out for the railway links

update site link to railway

…d mongo database, added dotenv, added error handler function for api testing in postman

…resources to mongodb.

… input.

…is needed to be created)..

…testing purposes only)

20jasper

I left some comments detailing some changes and some points of confusion. To fully migrate, I think you should also delete the "resources.js" file

20jasper · 2022-10-12T17:47:41Z

CONTRIBUTING.md

@@ -6,7 +6,16 @@ Contributions are what make the open source community such an amazing place to l

 <ins>Please make sure to follow our guidelines below before making any contributions.</ins>

-
+- [Contributing](#contributing)


Did anything change here, or did this section just get formatted?

Suggested change

- [Contributing](#contributing)

- [Contributing](#contributing)

- [Understanding Coding-Resources-API branch structure](#understanding-coding-resources-api-branch-structure)

- [Permanent Branches](#permanent-branches)

- [Main](#main)

- [Test](#test)

- [Resources](#resources)

- [How often should I stage changes?](#how-often-should-i-stage-changes)

- [Where should I make my pull request to?](#where-should-i-make-my-pull-request-to)

- [Creating an Issue](#creating-an-issue)

- [How to make a PR](#how-to-make-a-pr)

controllers/resourceController.js

20jasper · 2022-10-12T18:18:33Z

server.js

@@ -24,22 +35,9 @@ app.get('/api', (req, res) => {
 	res.json(resources);
 });

-app.get('/api/:keyword', (req, res) => {


Why is this route being deleted?

This is now located in the resourceRoutes, Jesse had just updated the endpoint

Co-authored-by: Jacob Asper <[email protected]>

… pulls information from mongoDB but this has removed capability to use partial keywords in a search. added nodemon as a dev dependency for testing: npm run dev

…ation/coding-resources-api into AmazingFeature

…rns resources for javascript

…tive matches for keyword

…lway.app/

jesseranon · 2022-10-12T20:15:16Z

These commits fix the get matches functions in js/main.js and handle resource searches through MongoDB.

server.js

changed /api/resources base endpoint to /api to maintain legacy endpoints

js/main.js

changed line 35 to fetch /api/:keyword endpoint to connect to database
removed data.filter() as resourceController would handle filtering

controllers/resourceController.js

changed Resource.find() parameters to use case-insensitive, partial matches for keyword

views/index.ejs

changed endpoint urls to point to the current railway url

Closing #105

LucasMERN and others added 28 commits June 16, 2022 20:13

Update README.md

290342c

Update README.md

0c91dec

Updated Roadmap

04c8d6c

added table of contents

c294e06

Merge pull request #89 from the-api-administration/contributing

efcc390

added table of contents

Merge pull request #91 from the-api-administration/test

2c7799b

Test -> Main Merge, Version 4

Merge pull request #95 from the-api-administration/test

0911594

Test

removed redundant app.use

40a4f99

changed paths in index.ejs

f778159

set up public folder

e4f6351

Merge pull request #98 from the-api-administration/public-folder

9ae3f96

Public folder

Fix typo

6f195f2

changed recieve to receive

Merge pull request #100 from the-api-administration/20jasper-patch-1

4fb8ff4

Fix typo

update site link to railway

ec4c9d2

change the heroku links out for the railway links

Merge pull request #101 from the-api-administration/update-site-link

8441132

update site link to railway

Added Mongoose, Express-Async Handler, dotenv

5a7f678

Replaced keyword endpoint & abstracted into resourceControllers. Adde…

fd73863

…d mongo database, added dotenv, added error handler function for api testing in postman

Added keyword param route, and created POST req route for adding new …

96fd4df

…resources to mongodb.

Connected mongoDB server to application.

a27e4fe

Created model schema for adding new resources to database

30ebcac

Created API Endpoint (GET) for fetching search results based off user…

2211d6d

… input.

Added POST API Endpoint for adding new resources to MongoDB. (A View …

ba141c6

…is needed to be created)..

Created Middleware for detecting status errors in Postman. (Used for …

3f48d5f

…testing purposes only)

Moved .dotenv file into config

43a74ff

Added an example comment of how schema is validating keywords

ee587ca

Made resource(s) plural

a9fe8f4

Turned function getResources plural

8718ae3

Merge branch 'test' into AmazingFeature

5bcee4f

ssaryonjr requested review from Ethodeus and 20jasper October 12, 2022 04:03

20jasper requested changes Oct 12, 2022

View reviewed changes

schneedotdev and others added 6 commits October 12, 2022 15:13

Update controllers/resourceController.js

f54d690

Co-authored-by: Jacob Asper <[email protected]>

main.js getMatches now uses /api/resources/:keyword route. Search now…

a37b5b4

… pulls information from mongoDB but this has removed capability to use partial keywords in a search. added nodemon as a dev dependency for testing: npm run dev

Merge branch 'AmazingFeature' of https://github.com/the-api-administr…

e222c97

…ation/coding-resources-api into AmazingFeature

added back partial searches i.e. a search with java as the input retu…

e976347

…rns resources for javascript

getResources Resource.find now uses and to find partial, case-insensi…

5fbaa34

…tive matches for keyword

changed endpoint urls to current: https://coding-resources-api.up.rai…

d41ff42

…lway.app/

jesseranon mentioned this pull request Oct 12, 2022

Update links on front end from heroku to railway #105

Open

Danamitecoder added 2 commits October 12, 2022 19:27

migrating index routes

d3731c5

adding routes to endpoint and updating comments

9eaf341

schneedotdev closed this Oct 13, 2022

schneedotdev deleted the AmazingFeature branch October 13, 2022 01:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrated JSON Files to MongoDB. Abstracted Server functionality into MVC (Model & Controllers) #104

Migrated JSON Files to MongoDB. Abstracted Server functionality into MVC (Model & Controllers) #104

ssaryonjr commented Oct 12, 2022

20jasper left a comment

20jasper Oct 12, 2022

20jasper Oct 12, 2022

schneedotdev Oct 12, 2022

jesseranon commented Oct 12, 2022 •

edited

Loading

		@@ -6,7 +6,16 @@ Contributions are what make the open source community such an amazing place to l

		<ins>Please make sure to follow our guidelines below before making any contributions.</ins>


		- [Contributing](#contributing)

-- [Contributing](#contributing)
+- [Contributing](#contributing)
+  - [Understanding Coding-Resources-API branch structure](#understanding-coding-resources-api-branch-structure)
+    - [Permanent Branches](#permanent-branches)
+      - [Main](#main)
+      - [Test](#test)
+      - [Resources](#resources)
+  - [How often should I stage changes?](#how-often-should-i-stage-changes)
+  - [Where should I make my pull request to?](#where-should-i-make-my-pull-request-to)
+  - [Creating an Issue](#creating-an-issue)
+  - [How to make a PR](#how-to-make-a-pr)

Migrated JSON Files to MongoDB. Abstracted Server functionality into MVC (Model & Controllers) #104

Migrated JSON Files to MongoDB. Abstracted Server functionality into MVC (Model & Controllers) #104

Conversation

ssaryonjr commented Oct 12, 2022

Summary:

Dependencies

Server.js

Routes & Controllers

Model

Config

Middleware

20jasper left a comment

Choose a reason for hiding this comment

20jasper Oct 12, 2022

Choose a reason for hiding this comment

20jasper Oct 12, 2022

Choose a reason for hiding this comment

schneedotdev Oct 12, 2022

Choose a reason for hiding this comment

jesseranon commented Oct 12, 2022 • edited Loading

These commits fix the get matches functions in js/main.js and handle resource searches through MongoDB.

server.js

js/main.js

controllers/resourceController.js

views/index.ejs

jesseranon commented Oct 12, 2022 •

edited

Loading