React Notes

classic React Notes app built with React.js

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Folder Structure
  • Tech Stack
• Getting Started
  • Installation
  • Run Locally
• Contributing
• License
• Contact
• Acknowledgements

🌟 About the Project

This repository houses a well-designed and functional React Notes App - the best place to jot down quick thoughts or to save longer notes built with React.js and UUID package ⚛

‼️ Folder Structure

Here is the folder structure of React-Notes

React-Notes-App/
|- public/
|- src/
  |-- components/
  |-- pages/
  |-- App.js
  |-- index.js
  |-- index.css

Now, lets dive into the src and public folders.

public

index.html - manifest.json

The public folder contains the HTML file so you can tweak it, for example, to set the page title. The <script> tag with the compiled code will be added to it automatically during the build process.

src

components

NoteColors.js - NoteItem.jsx - UseCreateDate.jsx

JSX files contain React-Notes components which split the UI into independent and reusable pieces.

NoteColors.js - This file contains [getRandomColor] function which select randomly the color from an hex-code array for the note.
NoteItem.jsx - This component display preview of note item, including title and date.
UseCreateDate.jsx - This component used for creating custom DateTime format.

pages

CreateNote.jsx - EditNote.jsx - Notes.jsx - index.js

JSX files contain React-Notes pages such as creating notes, editing notes and feed of notes.

CreateNote.jsx - This file describe the UI and functionality of create note page.
EditNote.jsx - This file describe the UI and functionality of edit note page.
Note.jsx - This file describe the UI and functionality of feed notes page.

👾 Tech Stack

(back to top)

🧰 Getting Started

⚙️ Installation

Step 1:

Download or clone this repo by using the link below:

 https://github.com/ladunjexa/React-Notes-App

Step 2:

React-Notes using NPM (Node Package Manager), therefore, make sure that Node.js is installed by execute the following command in console:

  node -v

Step 3:

At the main folder execute the following command in console to get the required dependencies:

  npm install

Step 4:

At the main folder execute the following command in console to creates a build directory with a production build of next-portfolio:

  npm run build

Step 5:

At the main folder execute the following command in console to run the server:

  npm run start

🏃 Run Locally

Step 1:

At the main folder execute the following command in console to get the required dependencies:

  npm install

Step 2:

At the main folder execute the following command in console to run the development server:

  npm run dev

(back to top)

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

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. Fork the Project
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

(back to top)

⚠️ License

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

(back to top)

🤝 Contact

Liron Abutbul - @lironabutbul6 - @ladunjexa

Project Link: https://github.com/ladunjexa/React-Notes-App

(back to top)

💎 Acknowledgements

This section used to mention useful resources and libraries that used in React-Notes

• react icons
• uuid v4

(back to top)