-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b5caa25
Showing
59 changed files
with
35,191 additions
and
0 deletions.
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| ## MERN-STUCK CRUD-APP-WITH-FILE-UPLOADING | ||
|
|
||
| [![Youtube][youtube-shield]][youtube-url] | ||
| [![Facebook][facebook-shield]][facebook-url] | ||
| [![Instagram][instagram-shield]][instagram-url] | ||
| [![LinkedIn][linkedin-shield]][linkedin-url] | ||
|
|
||
| Thanks for visiting my GitHub account! | ||
|
|
||
|  | ||
|
|
||
| Web development refers to the creating, building, and maintaining of websites. It includes aspects such as web design, web publishing, web programming, and database management. One of the most famous stacks that is used for Web Development is the MERN stack. This stack provides an end-to-end framework for the developers to work in and each of these technologies play a big part in the development of web applications. [more](https://www.geeksforgeeks.org/mern-stack/) | ||
|
|
||
| ## Source Code (Download) | ||
|
|
||
| - [Source-code]() | ||
| - [Documentation](https://github.com/learnwithfair/node-express-documentation) | ||
|
|
||
| ## Required Software (Download) | ||
|
|
||
| - VS Code, Download ->https://code.visualstudio.com/download | ||
| - Node, Download-> https://nodejs.org/en/download | ||
| - MongoDB Shell(msi) , Download-> https://www.mongodb.com/try/download/shell | ||
| - MongoDB Compass (msi), Download-> https://www.mongodb.com/try/download/community | ||
| - Postman, Download-> https://www.postman.com/downloads/ | ||
|
|
||
| **Or Online Database (MongoDB Atlas)** | ||
|
|
||
| - Register -> https://www.mongodb.com/cloud/atlas/register | ||
|
|
||
| ## ========== Environment Setup ========== | ||
|
|
||
| 1. Install Node.js | ||
| 2. To verify installation into command form by node -v | ||
| 3. For initialization npm write the query in the command window as npm init -y | ||
| 4. Setup the opening file into the package.json and change the file with main:'server.js' | ||
| 5. To create a server using the express package then write a query into the command window as npm install express. | ||
| Write code in the server file for initialization | ||
| const express = require("express"); | ||
| const app = express(); | ||
| app.listen(3000, () => { | ||
| console.log("Server is running at http://localhost:3000"); | ||
| }); | ||
|
|
||
| 6. Install the nodemon package for automatically running the server as- npm i --save-dev nodemon (For Developing purpose) | ||
| 7. setup the package.json file in the scripts key, write | ||
| "scripts": { | ||
| "start": "node ./resources/backend/server.js", | ||
| "dev": "nodemon ./resources/backend/server.js", | ||
| "test": "echo \"Error: no test specified\" && exit 1" | ||
| }, | ||
| 8. use the Morgan package for automatic restart. Hence install the morgan package as npm install --save-dev morgan (Development purpose) | ||
| Write code in the server file for initialization | ||
| const morgan = require("morgan"); | ||
| app.use(morgan("dev")); --> Middlewire. | ||
| 9. Install Postman software for API testing by the URL endpoint. | ||
| 10. Install Mongobd + MongobdCompass and Mongoshell (For Database) | ||
|
|
||
| ## ========== Connect MongoDB Database ========== | ||
|
|
||
| 1. Install Mondodb + Mongodb Compass and Mongodb Shell download from the google. | ||
| 2. Set up Environment Variable in drive:c/program file | ||
| 3. Create a directory in the base path of the c drive named data. Inside the data directory create another folder db. | ||
| 4. Write the command in the CMD window as Mongod. And write the other command in the other CMD window as mongosh. | ||
| 5. Then Check the version as mongod --version and mongosh --version. | ||
| 6. Install mongoose package as npm i mongoose | ||
| 7. Create an atlas account. In the atlas account create a cluster that have a user(as atlas admin) and network access with any access IP address. | ||
| 8. Connect the database using URL from the atlas cluster or local Mongodb compass using the mongoose package as mongoose. connect('mongodb://localhost:27017/database-name); | ||
|
|
||
| ## Step-1 Run Command in Terminal (client) | ||
|
|
||
| ```bash | ||
| cd front-end | ||
| npm install --force | ||
| npm start | ||
| ``` | ||
|
|
||
| ## Step-2: Server Side Configuration | ||
|
|
||
| ### API-> server/.env | ||
|
|
||
| ```bash | ||
| SERVER_PORT=3002 | ||
| DB_URL=From-Atlas-cluster-account | ||
| MAX_FILE_SIZE= 1024 * 1024 * 2; // 2MB | ||
| ALLOWED_FILE_TYPES= [ 'jpg', 'jpeg', 'png' ] | ||
| UPLOAD_DIR= 'public/images/users' | ||
|
|
||
| ``` | ||
|
|
||
| ## Step-3 Run Command in another Terminal (server) | ||
|
|
||
| ```bash | ||
| cd server | ||
| npm install --force | ||
| npm start | ||
| ``` | ||
|
|
||
| ## Template Includes | ||
|
|
||
| - React-js | ||
| - Express-js | ||
| - mongoose | ||
| - multer | ||
| - dotenv | ||
| - cors | ||
| - nodemon | ||
| - MongoDB | ||
|
|
||
| ## Necessary Code | ||
|
|
||
| ```bash | ||
| const express = require("express"); // Create Express server | ||
| const morgan = require("morgan"); // For automatically run server | ||
| const cookieParser = require("cookie-parser"); // For set Cookie | ||
| const createError = require("http-errors"); // For create HTTP Error | ||
| const xssClean = require("xss-clean"); // For Secure API | ||
| const bodyParser = require("body-parser"); // For Get/ Set data into body | ||
| const cors = require("cors"); // To set access for client-side URL | ||
| ``` | ||
|
|
||
| /_ | ||
| |-------------------------------------------------------------------------- | ||
| | Initialize Middleware | ||
| |-------------------------------------------------------------------------- | ||
| _/ | ||
|
|
||
| ```bash | ||
| app.use(cookieParser()); // For set Cookie | ||
| app.use(morgan("dev")); // For automatically run server | ||
| app.use(xssClean()); // For Secure api | ||
| app.use(bodyParser.json()); // For Set, Read data into the body and display JSON Format Text | ||
| app.use(bodyParser.urlencoded({ extended: true })); // Get HTML Form Data | ||
| app.use(setRefreshToken); // For set Refresh Token [Automatically call this middleware for all route] | ||
| // To get access to Client side URL | ||
| app.use(cors( | ||
| { | ||
| origin: BASE_URL, // Frontend Base URL | ||
| credentials: true | ||
| } | ||
| )); | ||
| app.use(express.static("public")); // To Display Server site image | ||
| ``` | ||
|
|
||
| /_ | ||
| |-------------------------------------------------------------------------- | ||
| | Socket IO | ||
| |-------------------------------------------------------------------------- | ||
| _/ | ||
|
|
||
| ```bash | ||
| const io = require("socket.io")(8080, { | ||
| cors: { | ||
| origin: BASE_URL | ||
| }, | ||
| }); | ||
| io.on("connection", (socket) => { | ||
| console.log("User connected", socket.id); | ||
|
|
||
| setInterval(() => { | ||
| io.emit("refresh", {}); | ||
| }, 500) | ||
|
|
||
| // socket.on("disconnect", function () { | ||
| // console.log("Disconnect"); | ||
|
|
||
| // }) | ||
|
|
||
| }); | ||
| ``` | ||
| ## Follow Me | ||
| [<img src='https://cdn.jsdelivr.net/npm/[email protected]/icons/github.svg' alt='github' height='40'>](https://github.com/learnwithfair) [<img src='https://cdn.jsdelivr.net/npm/[email protected]/icons/facebook.svg' alt='facebook' height='40'>](https://www.facebook.com/learnwithfair/) [<img src='https://cdn.jsdelivr.net/npm/[email protected]/icons/instagram.svg' alt='instagram' height='40'>](https://www.instagram.com/learnwithfair/) [<img src='https://cdn.jsdelivr.net/npm/[email protected]/icons/twitter.svg' alt='twitter' height='40'>](https://www.twiter.com/learnwithfair/) [<img src='https://cdn.jsdelivr.net/npm/[email protected]/icons/youtube.svg' alt='YouTube' height='40'>](https://www.youtube.com/@learnwithfair) | ||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| [youtube-shield]: https://img.shields.io/badge/-Youtube-black.svg?style=flat-square&logo=youtube&color=555&logoColor=white | ||
| [youtube-url]: https://youtube.com/@learnwithfair | ||
| [facebook-shield]: https://img.shields.io/badge/-Facebook-black.svg?style=flat-square&logo=facebook&color=555&logoColor=white | ||
| [facebook-url]: https://facebook.com/learnwithfair | ||
| [instagram-shield]: https://img.shields.io/badge/-Instagram-black.svg?style=flat-square&logo=instagram&color=555&logoColor=white | ||
| [instagram-url]: https://instagram.com/learnwithfair | ||
| [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 | ||
| [linkedin-url]: https://linkedin.com/company/learnwithfair |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
|
||
| # dependencies | ||
| /node_modules | ||
| /.pnp | ||
| .pnp.js | ||
|
|
||
| # testing | ||
| /coverage | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # misc | ||
| .DS_Store | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Getting Started with Create React App | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
|
|
||
| ## Available Scripts | ||
|
|
||
| In the project directory, you can run: | ||
|
|
||
| ### `npm start` | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
|
|
||
| The page will reload when you make changes.\ | ||
| You may also see any lint errors in the console. | ||
|
|
||
| ### `npm test` | ||
|
|
||
| Launches the test runner in the interactive watch mode.\ | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
|
|
||
| ### `npm run build` | ||
|
|
||
| Builds the app for production to the `build` folder.\ | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
|
|
||
| The build is minified and the filenames include the hashes.\ | ||
| Your app is ready to be deployed! | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
|
|
||
| ### `npm run eject` | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can't go back!** | ||
|
|
||
| If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. | ||
|
|
||
| Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. | ||
|
|
||
| You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. | ||
|
|
||
| ## Learn More | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
|
|
||
| ### Code Splitting | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) | ||
|
|
||
| ### Analyzing the Bundle Size | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) | ||
|
|
||
| ### Making a Progressive Web App | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) | ||
|
|
||
| ### Advanced Configuration | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) | ||
|
|
||
| ### Deployment | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) | ||
|
|
||
| ### `npm run build` fails to minify | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) |
Oops, something went wrong.