Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/a-tetarwal/mil-lo-na
Mil Lo Na is a simple note-taking application that allows users to create and view notes. The notes are stored as text files on the local storage itself in the assigned folder.
https://github.com/a-tetarwal/mil-lo-na
crud-operations ejs expressjs filesystem nodejs view-engine
Last synced: 3 days ago
JSON representation
Mil Lo Na is a simple note-taking application that allows users to create and view notes. The notes are stored as text files on the local storage itself in the assigned folder.
- Host: GitHub
- URL: https://github.com/a-tetarwal/mil-lo-na
- Owner: A-Tetarwal
- License: mit
- Created: 2024-07-15T15:49:01.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-19T17:18:24.000Z (6 months ago)
- Last Synced: 2024-11-09T19:43:31.914Z (about 2 months ago)
- Topics: crud-operations, ejs, expressjs, filesystem, nodejs, view-engine
- Language: EJS
- Homepage: https://a-tetarwal.github.io/Mil-Lo-Na/
- Size: 1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mil Lo Na
Mil Lo Na is a simple note-taking application that allows users to create, edit and view notes. The notes are stored as text files on the server.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Folder Structure](#folder-structure)
- [Technologies Used](#technologies-used)
- [License](#license)
## Features
- Create notes with a title and description.
- View a list of created notes.
- Read individual notes.
- Edit or update notes
## Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/mil-lo-na.git
2. Navigate to the project directory:
```bash
cd mil-lo-na
3. Install the dependencies:
```bash
npm install
4. Create the necessary folders:
```bash
mkdir public/images public/stylesheets public/javascripts files
5. (Optional) Add your own logo to the public/images directory and name it logo.svg.
## Usage
1. Start the server:
```bash
node index.js
2. Open your web browser and navigate to:
```bash
http://localhost:3000
3. Use the form to create new notes. The notes will be listed below the form, and you can click "Read more" to view individual notes.
## Folder StruCture
```php
mil-lo-na/
├── files/ # Folder to store notes as text files
├── node_modules/
├── public/
│ ├── images/ # Public images folder
│ ├── javascripts/ # Public JavaScript files
│ └── stylesheets/ # Public CSS files
├── views/
│ └── index.ejs # Main view template
├── index.js # Main server file
├── package.json
├── README.md
```
## Technologies Used
- Node.js
- Express
- EJS
- Tailwind CSS
## License
This project is licensed under the MIT License - see the LICENSE file for details.
```less
Make sure to replace `https://github.com/yourusername/mil-lo-na.git` with the actual URL of your GitHub repository. This README file provides a comprehensive overview of your project, including installation instructions, usage, and folder structure.
```