Skip to content

mufleeh/web-notes-project

Repository files navigation

Web Notes Project

This project is a web application designed to organize and save notes in Markdown format. It provides a user-friendly interface for creating, editing, and viewing notes.

Features

  • Create and edit notes using Markdown syntax.
  • Save notes locally in the browser.
  • Display a list of saved notes on the main page.

Project Structure

web-notes-project/
├── package.json
├── package-lock.json
├── README.md
├── tsconfig.json
├── webpack.config.js
├── .gitignore
├── notes/
│   ├── authentication.md
│   ├── best-practices.md
│   ├── ci-cd.md
│   ├── code-snippets.md
│   ├── coding-standards.md
│   ├── component-diagram.md
│   ├── configuration.md
│   ├── data-flow.md
│   ├── deployment-guide.md
│   ├── endpoints.md
│   ├── environment-setup.md
│   ├── environments.md
│   ├── faqs.md
│   ├── features.md
│   ├── goals.md
│   ├── installation.md
│   ├── integration-tests.md
│   ├── limitations.md
│   ├── notes.md
│   ├── overview.md
│   ├── references.md
│   ├── request-response.md
│   ├── system-design.md
│   ├── test-cases.md
│   ├── troubleshooting.md
│   ├── unit-tests.md
├── public/
│   ├── index.html
├── src/
│   ├── index.tsx
│   ├── components/
│   │   ├── NoteEditor.tsx
│   │   ├── Sidebar.tsx
│   │   ├── TabPanel.tsx
│   │   ├── Tabs.tsx
│   ├── pages/
│   │   ├── Home.tsx
│   ├── styles/
│   │   ├── main.css
│   ├── utils/
│   │   ├── index.ts

Setup Instructions

  1. Clone the repository:

    git clone <repository-url>
    
  2. Navigate to the project directory:

    cd web-notes-project
    
  3. Install dependencies:

    npm install
    
  4. Start the development server:

    npm start
    

Usage

  • Open the application in your browser.
  • Use the NoteEditor to create and edit notes.
  • Saved notes will be displayed on the Home page.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any enhancements or bug fixes.

License

This project is licensed under the MIT License.

About

Notes for Web MVP

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published