Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sheel-ui/note-down
https://github.com/sheel-ui/note-down
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sheel-ui/note-down
- Owner: Sheel-ui
- Created: 2024-03-31T04:04:52.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-19T14:56:18.000Z (8 months ago)
- Last Synced: 2024-05-19T15:47:50.305Z (8 months ago)
- Language: JavaScript
- Size: 5.49 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Note-Down Application
The Note-Down Application is a note-taking solution that offers a seamless user experience with its React frontend and Node.js backend. It empowers users to effortlessly write down notes, revisit them later for review, and efficiently manage their notes by deleting them when no longer needed.
### Features
-
**Dark and light modes**: Offers both dark and light modes, allowing users to choose a theme that suits their preferences.
- **Infinite scroll**: With infinite scroll functionality, users can smoothly navigate through their notes without interruption.
- **Intuitive Note Management:** Users can easily create new notes, review existing ones, and delete notes they no longer require.
# Getting Started
To get started with Note-Down, follow these steps:
### Install Dependencies
1. Clone the repository to your local machine.
2. Navigate to the project directory and run the following command to install the necessary dependencies:
```bash
$ npm i
```
### Starting the JSON Server
Note-Down utilizes a JSON server for its infinite scroll functionality. Start the server by running the following command:
```bash
$ npx json-server --watch ./data/data.json --port 8000
```
### Starting the application
To start the application, use the following command:
```bash
$ npm start
```
These steps will get your Note-Down application up and running, allowing you to start taking notes seamlessly.
# Demo
