Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neeldevenshah/inotebook
https://github.com/neeldevenshah/inotebook
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/neeldevenshah/inotebook
- Owner: NeelDevenShah
- Created: 2022-06-20T08:10:57.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T20:20:20.000Z (4 months ago)
- Last Synced: 2024-09-07T21:30:59.728Z (4 months ago)
- Language: JavaScript
- Size: 3.14 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# iNotebook Application
This is a notebook application built using the MERN stack (MongoDB, Express.js, React.js, Node.js). The application allows users to create, read, update, and delete notes. It includes a simple user authentication system and a user-friendly interface for managing notes.
## Table of Contents
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Create Notes**: Add new notes with a title and content.
- **Read Notes**: View all your notes.
- **Update Notes**: Edit existing notes.
- **Delete Notes**: Remove notes you no longer need.
- **User Authentication**: Secure sign-up and login.
- **Responsive Design**: Works on both desktop and mobile devices.
## Tech Stack
- **Frontend**: React.js
- **Backend**: Node.js with Express.js
- **Database**: MongoDB
- **Authentication**: JWT (JSON Web Tokens)
- **Styling**: CSS
## Installation
To get started with the notebook application, follow these steps:
1. **Clone the Repository**
```bash
git clone https://github.com/yourusername/notebook-application.git
```
2. **Navigate to the Project Directory**
```bash
cd notebook-application
```
3. **Install Backend Dependencies**
```bash
cd backend
npm install
```
4. **Install Frontend Dependencies**
```bash
cd ../frontend
npm install
```
5. **Set Up Environment Variables**
Create a `.env` file in the backend directory and add the following variables:
```env
MONGO_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret
```
6. **Run the Application**
- Start the Backend Server
```bash
cd backend
npm start
```
- Start the Frontend Development Server
```bash
cd ../frontend
npm start
```
7. **Access the Application**
Open your browser and navigate to [http://localhost:3000](http://localhost:3000) to access the application.
## Usage
- Sign Up or Log In
- Go to the sign-up page to create a new account.
- Log in with your credentials.
- Manage Notes
- Use the dashboard to create, view, update, and delete notes.
## Contributing
If you'd like to contribute to the project, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes and commit (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Create a new Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Feel free to modify and extend this README to better suit your project’s specific needs!