Skip to content

lalomax/Notes-app

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Notes-app

About The Project

image

this React application provides a user interface for managing markdown notes, allowing users to create, edit, and delete them.

Proposed by: scrimba

Built With

  • Vite
  • React

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Check if Node.js is installed
    node -v

If it is not installed, download and install it.

Installation

  1. Clone the repo

    git clone https://github.com/lalomax/Notes-app.git
  2. Open directory

    cd Notes-app
  3. Install NPM packages

    npm install
  4. Run in development mode

    npm run dev

(back to top)

Roadmap

  • Add Changelog
  • Multi-language Support
    • Spanish

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Clone the repository
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request
flowchart 
    A(1. Clone the repository) --> B((Clone Fork))
    B --> C{2. Create Feature Branch}
    C --> D[Make Changes]
    D --> E((3. Commit Changes))
    E --> F((4. Push Changes))
    F --> G((5. Create Pull Request))
    G -- Approved --> H((Merge Pull Request))
    G -- Rejected --> D
Loading

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Your Name - https://x.com/OrlandoFloresH - createc.bo@gmail.com

Project Link: https://github.com/lalomax/travel-journal

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)