Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samya-s/inotebook
iNotebook - Your notes secured in the cloud. Made with React.js, Express.js and MongoDB
https://github.com/samya-s/inotebook
full-stack inotebook mern notebook notes notes-app
Last synced: 15 days ago
JSON representation
iNotebook - Your notes secured in the cloud. Made with React.js, Express.js and MongoDB
- Host: GitHub
- URL: https://github.com/samya-s/inotebook
- Owner: Samya-S
- License: mpl-2.0
- Created: 2024-03-04T13:54:59.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-06-12T13:35:52.000Z (6 months ago)
- Last Synced: 2024-06-12T19:32:09.786Z (6 months ago)
- Topics: full-stack, inotebook, mern, notebook, notes, notes-app
- Language: JavaScript
- Homepage: https://inotebook-ss.vercel.app
- Size: 731 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iNotebook
Your 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.
## Table of Contents
- [Folder structure](#folder-structure)
- [Installation](#installation)
- [Defining environment variables](#defining-environment-variables)
- [Run the development environment](#run-the-development-environment)
## Folder structure
```bash
inotebook
├── backend
│ ├── ...
│ └── ...
├── public
│ └── ...
├── src
│ ├── ...
│ └── ...
├── .gitignore
├── package-lock.json
├── package.json
└── README.md
```
## Installation
1. Clone the repository:
```bash
git clone [email protected]:Samya-S/inotebook.git
```
`Make sure you have SSH keys setup in your machine`
2. Navigate to the project directory:
```bash
cd inotebook
```
3. Install dependencies:
In the parent directory
```bash
npm i
```
In the backend directory
```bash
cd backend
npm i
```
`Make sure to have nodejs and npm installed`
## Defining environment variables
1. In the parent directory:
```bash
REACT_APP_BACKEND_HOSTING_DOMAIN = ''
```
1. In the backend directory:
```bash
MONGO_URI = ''
```
## Run the development environment
### To run both together
1. Navigate to the parent directory
2. Use the following command to run:
```bash
npm run both
```
### To run the frontend separately:
1. Navigate to the parent directory
2. Use the following command to run:
```bash
npm start
```
### To run the backend separately:
1. Navigate to the backend directory:
```bash
cd backend
```
2. Use the following command to run:
```bash
nodemon index.js
```
or alternatively
```bash
npm start
```