{"id":22618765,"url":"https://github.com/samya-s/inotebook","last_synced_at":"2025-03-29T01:28:18.741Z","repository":{"id":237631590,"uuid":"766985395","full_name":"Samya-S/inotebook","owner":"Samya-S","description":"iNotebook - Your notes secured in the cloud. Made with React.js, Express.js and MongoDB","archived":false,"fork":false,"pushed_at":"2024-06-12T13:35:52.000Z","size":749,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-03T11:33:25.664Z","etag":null,"topics":["full-stack","inotebook","mern","notebook","notes","notes-app"],"latest_commit_sha":null,"homepage":"https://inotebook-ss.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Samya-S.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2024-03-04T13:54:59.000Z","updated_at":"2024-06-12T13:35:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"3cfc00c0-3177-481f-a141-61842a49b260","html_url":"https://github.com/Samya-S/inotebook","commit_stats":null,"previous_names":["samya-s/inotebook"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Samya-S%2Finotebook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Samya-S%2Finotebook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Samya-S%2Finotebook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Samya-S%2Finotebook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Samya-S","download_url":"https://codeload.github.com/Samya-S/inotebook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246124899,"owners_count":20727333,"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":["full-stack","inotebook","mern","notebook","notes","notes-app"],"created_at":"2024-12-08T21:09:31.108Z","updated_at":"2025-03-29T01:28:18.726Z","avatar_url":"https://github.com/Samya-S.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# iNotebook\n\nYour notes secured in the cloud. A full-stack web application built using MERN stack, specifically `React.js` as frontend and `Express.js` and `MongoDB` as backend.\n\n## Table of Contents\n\n- [Folder structure](#folder-structure)\n- [Installation](#installation)\n- [Defining environment variables](#defining-environment-variables)\n- [Run the development environment](#run-the-development-environment)\n\n## Folder structure\n```bash\ninotebook\n├── backend\n│   ├── ...\n│   └── ...\n├── public\n│   └── ...\n├── src\n│   ├── ...\n│   └── ...\n├── .gitignore\n├── package-lock.json\n├── package.json\n└── README.md\n```\n\n## Installation\n\n1. Clone the repository:\n\n    ```bash\n    git clone git@github.com:Samya-S/inotebook.git\n    ```\n    `Make sure you have SSH keys setup in your machine`\n\n2. Navigate to the project directory:\n\n    ```bash\n    cd inotebook\n    ```\n\n3. Install dependencies:\n\n   In the parent directory\n   ```bash\n   npm i\n   ```\n   \n   In the backend directory\n   ```bash\n   cd backend\n   npm i\n   ```\n   `Make sure to have nodejs and npm installed`\n\n## Defining environment variables\n\n1. In the parent directory:\n\n    ```bash\n    REACT_APP_BACKEND_HOSTING_DOMAIN = '\u003cbackend hosting domain url\u003e'\n    ```\n1. In the backend directory:\n\n    ```bash\n    MONGO_URI = '\u003cmongo db url\u003e'\n    ```\n\n## Run the development environment\n\n### To run both together\n\n1. Navigate to the parent directory\n\n2. Use the following command to run:\n\n    ```bash\n    npm run both\n    ```\n\n### To run the frontend separately: \n\n1. Navigate to the parent directory\n\n2. Use the following command to run:\n\n    ```bash\n    npm start\n    ```\n\n### To run the backend separately: \n\n1. Navigate to the backend directory:\n\n    ```bash\n    cd backend\n    ```\n    \n2. Use the following command to run:\n\n    ```bash\n    nodemon index.js\n    ```\n   or alternatively\n    ```bash\n    npm start\n    ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamya-s%2Finotebook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamya-s%2Finotebook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamya-s%2Finotebook/lists"}