Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/techjmi/notes-app

Responsive-React-Notes-App
https://github.com/techjmi/notes-app

clone-app css-grid notes-app noteshare raectjs responsive

Last synced: about 1 month ago
JSON representation

Responsive-React-Notes-App

Awesome Lists containing this project

README 

        
# Notes App Project



This project is a simple notes management application developed using ReactJS and CSS. It allows users to create, edit, and delete notes, as well as switch between light and dark modes. The application is designed to be responsive, providing a seamless experience across various screen sizes.



## Features



- **Create Note:** Users can easily create new notes by entering text in the provided textarea and clicking the "Save" button.

- **Edit Note:** Existing notes can be edited by clicking the "Edit" button, making changes, and then saving the updated note.

- **Delete Note:** Notes can be deleted by clicking the "Delete" button associated with each note.

- **Dark/Light Mode:** The application supports both dark and light modes, allowing users to switch between them based on their preference.

- **Responsive Design:** The application is designed to adapt to different screen sizes, providing a consistent user experience across devices.



## Usage



1. **Creating a Note:**

   - Enter the desired text in the textarea provided.

   - Click the "Save" button to create the note.



2. **Editing a Note:**

   - Click the "Edit" button associated with the note you wish to edit.

   - Make changes to the note text in the textarea.

   - Click the "Save" button to save the changes.



3. **Deleting a Note:**

   - Click the "Delete" button associated with the note you wish to delete.



4. **Switching between Dark/Light Mode:**

   - Click the toggle button or switch provided to toggle between dark and light modes.



## Technologies Used



- **ReactJS:** Used for building the user interface and managing state.

- **CSS:** Used for styling the application and implementing responsive design.

- **LocalStorage:** Used to store notes locally in the browser for persistence across sessions.



## Getting Started



To run the project locally, follow these steps:



1. Clone the repository to your local machine:



   ```

   git clone https://github.com/techjmi/notes-app.git

   ```



2. Navigate to the project directory:



   ```

   cd notes-app

   ```



3. Install the dependencies:



   ```

   npm install

   ```



4. Start the development server:



   ```

   npm start

   ```



5. Open your web browser and visit `http://localhost:3000` to view the application.



## Credits



This project was created by [Md Shamim Akhter](https://musical-mooncake-8fc409.netlify.app/).



## Available Scripts



In the project directory, you can run:



### `npm start`



Runs the app in the development mode.\

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.



The page will reload when you make changes.\

You may also see any lint errors in the console.



### `npm test`



Launches the test runner in the interactive watch mode.\

See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.



### `npm run build`



Builds the app for production to the `build` folder.\

It correctly bundles React in production mode and optimizes the build for the best performance.



The build is minified and the filenames include the hashes.\

Your app is ready to be deployed!



See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.



### `npm run eject`



**Note: this is a one-way operation. Once you `eject`, you can't go back!**



If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.



Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.



You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.



## Learn More



You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).



To learn React, check out the [React documentation](https://reactjs.org/).



### Code Splitting



This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)



### Analyzing the Bundle Size



This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)



### Making a Progressive Web App



This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)



### Advanced Configuration



This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)



### Deployment



This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)



### `npm run build` fails to minify



This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)