{"id":22473328,"url":"https://github.com/arsy786/notes-mern-app","last_synced_at":"2025-12-30T20:32:32.994Z","repository":{"id":231369229,"uuid":"620023010","full_name":"arsy786/notes-mern-app","owner":"arsy786","description":"This is a web application built with the MERN stack that allows users to CRUD notes.","archived":false,"fork":false,"pushed_at":"2024-04-07T18:14:45.000Z","size":610,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"notes-app-with-redux-and-auth","last_synced_at":"2025-02-01T20:12:40.991Z","etag":null,"topics":["2023","expressjs","mern-stack","mongodb","nodejs","reactjs","tutorial"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arsy786.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-27T21:58:11.000Z","updated_at":"2024-03-23T17:39:05.000Z","dependencies_parsed_at":"2024-12-06T12:33:29.401Z","dependency_job_id":null,"html_url":"https://github.com/arsy786/notes-mern-app","commit_stats":null,"previous_names":["arsy786/notes-mern-app"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arsy786%2Fnotes-mern-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arsy786%2Fnotes-mern-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arsy786%2Fnotes-mern-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arsy786%2Fnotes-mern-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arsy786","download_url":"https://codeload.github.com/arsy786/notes-mern-app/tar.gz/refs/heads/notes-app-with-redux-and-auth","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245881148,"owners_count":20687679,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["2023","expressjs","mern-stack","mongodb","nodejs","reactjs","tutorial"],"created_at":"2024-12-06T12:22:29.416Z","updated_at":"2025-12-30T20:32:32.966Z","avatar_url":"https://github.com/arsy786.png","language":"JavaScript","readme":"# Notes MERN App\n\nThis is a simple Notes app designed for managing notes with ease. The app is built using the MERN (MongoDB, Express, React, Node.js) stack and supports essential CRUD (Create, Read, Update, Delete) operations. It utilizes MongoDB for database management, Express and Node.js for server-side functionality, and React for a dynamic front-end user experience.\n\n\u003c!-- Tutorial Guide: [Create a MERN CRUD App (YouTube/CodingWithRobby)](https://www.youtube.com/playlist?list=PL-LRDpVN2fZA-1igOQ6PDcqfBjS-vaC7w) --\u003e\n\n## Branches\n\n    - main: frontend has no redux or components, everything is in App.js\n    - notes-app-with-redux: frontend is separated into components and uses redux toolkit to manage global state.\n    - notes-app-with-redux-and-auth: same as above branch but implemented auth \u0026 styling into the frontend.\n\n## Getting Started\n\nThis project is divided into two main parts: the backend and the frontend. Follow these steps to set up and run both parts of the application.\n\n### Prerequisites\n\n- Node.js\n- MongoDB\n\n### Cloning the Repo\n\n1. Open your terminal or command prompt.\n\n2. Clone the repository using Git:\n\n   ```bash\n   git clone https://github.com/arsy786/notes-mern-app.git\n   ```\n\n3. Navigate to the cloned repository's root directory\n\n   ```bash\n   cd notes-mern-app\n   ```\n\n### Setting up the Backend\n\n1. From the root directory, navigate to the backend directory:\n\n   ```bash\n   cd backend\n   ```\n\n2. Install the required Node.js modules:\n\n   ```bash\n   npm install\n   ```\n\n3. Create a .env file in the backend directory and add the following:\n\n   ```env\n   PORT=3001\n   MONGODB_URI=\u003cYour MongoDB connection string\u003e\n   SECRET=\u003cYour JWT secret key\u003e\n   ```\n\n4. Start the backend:\n\n   ```bash\n   npm run dev\n   ```\n\n   The backend should now be running on `http://localhost:3001`.\n\n### Setting up the Client\n\n1. Open a new terminal or command prompt window.\n\n2. From the root directory, navigate to the frontend directory:\n\n   ```bash\n   cd frontend\n   ```\n\n3. Install the required Node.js modules:\n\n   ```bash\n   npm install\n   ```\n\n4. Start the frontend:\n\n   ```bash\n   npm run start\n   ```\n\n   The frontend should now be running on `http://localhost:3000`.\n\n### Accessing the Application\n\nAfter starting both the backend and frontend servers, you can access the web application by navigating to `http://localhost:3000` in your web browser. Ensure both servers are running concurrently to allow the frontend to communicate with the backend effectively.\n\n## Backend\n\nThe backend provides a REST API for managing notes \u0026 users. Here are the available endpoints:\n\n    - GET /api/notes - Get all notes\n    - GET /api/notes/:id - Get a single note by ID\n    - POST /api/notes - Create a new note\n    - PUT /api/notes/:id - Update an existing note by ID\n    - DELETE /api/notes/:id - Delete a note by ID\n\n    - POST /api/auth/signup - Register a new user\n    - POST /api/auth/login - Login a user\n    - GET /api/auth/logout - Logout a user\n    - GET /api/auth/check-auth - Endpoint to check if user is authenticated\n\nThe API requires user authentication with JSON Web Tokens (JWT). To authenticate a user, send a `POST` request to `/api/auth/login` with a JSON body containing the `email` and `password` fields. The server will respond with a JWT, which should be included in subsequent requests to protected endpoints.\n\n## Frontend\n\nThe app provides the following features:\n\n    - View a list of notes\n    - Create a new note\n    - Update a note\n    - Delete a note\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farsy786%2Fnotes-mern-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farsy786%2Fnotes-mern-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farsy786%2Fnotes-mern-app/lists"}