Skip to content

sumo47/NoteBook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NoteBook

A React-based Note Taking App designed to create, edit, and organize notes efficiently.

Features

  • Create and Manage Notes: Add, edit, and delete notes in an organized manner.
  • Simple UI: Easy-to-use interface designed for productivity.
  • Real-time Updates: Enjoy quick interaction with the UI, powered by React.
  • Deployed Version: You can view the live version here.

Project Structure

src/
├── components/
│   └── Note.js          # Component for individual note display
├── pages/
│   └── Home.js          # Main homepage layout
├── services/
│   └── ApiService.js    # Handles API interactions
└── App.js               # Root component for the application

Installation

To run this project locally, follow the steps:

  1. Clone the repository:

    git clone https://github.com/sumo47/NoteBook.git
  2. Navigate to the project directory:

    cd NoteBook
  3. Install dependencies:

    npm install
  4. Run the app:

    npm start

    This will start the application on http://localhost:3000.

Available Scripts

  • npm start: Runs the app in development mode.
  • npm test: Launches the test runner.
  • npm run build: Builds the app for production.

Technologies Used

  • React: A JavaScript library for building user interfaces.
  • BOOTSTRAP: For styling the components.
  • JSONWEBTOKEN: For authentication.
  • Netlify: For deployment of the live version.

Future Enhancements

  • Offline Mode: Allow note access when the user is offline.
  • Categorization: Implement categories/tags for better note organization.

Contributing

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature-branch).
  3. Commit your changes (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a pull request.

License

This project is open source.