https://github.com/muhthoriqas/notes-app-hapi
Simple Notes API Using Hapi Framework
https://github.com/muhthoriqas/notes-app-hapi
hapi-framework hapi-framework-app notes-api notes-api-hapi-framework notes-app
Last synced: 3 months ago
JSON representation
Simple Notes API Using Hapi Framework
- Host: GitHub
- URL: https://github.com/muhthoriqas/notes-app-hapi
- Owner: Muhthoriqas
- License: mit
- Created: 2023-03-19T12:45:08.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-21T16:27:12.000Z (about 2 years ago)
- Last Synced: 2025-01-16T19:48:51.925Z (4 months ago)
- Topics: hapi-framework, hapi-framework-app, notes-api, notes-api-hapi-framework, notes-app
- Language: JavaScript
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notes App using Hapi Framework
This repository contains a simple Notes App built using Hapi Framework. The app allows users to add, edit, and delete notes. It consists of four main files located in the `src` directory: `handler.js`, `notes.js`, `routes.js`, and `server.js`.
## Requirements
To run this app, you'll need to have the following installed:
- [Node.js](https://nodejs.org/en/)
- [npm](https://www.npmjs.com/)
- [Hapi Framework](https://hapi.dev/)
- [Nodemon](https://nodemon.io/)
## Installation
1. Clone this repository to your local machine using `git clone https://github.com/Muhthoriqas/Notes-App-Hapi.git`
2. Navigate to the project directory using `cd Notes-App-Hapi`
3. Install the necessary dependencies using `npm install`
## Usage
1. Start the server using `npm run dev`
2. Open your web browser and navigate to `http://localhost:5000/notes`
3. Use the postman to add, edit, and delete notes
## Code Structure
- `handler.js`: Contains the logic for handling requests and responses
- `notes.js`: Contains an array of notes that is used by the app
- `routes.js`: Defines the routes for the app
- `server.js`: Starts the server and registers the routes
## Code Style
This project uses [ESLint](https://eslint.org/) with the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for code linting and formatting. Please ensure that your code follows this style guide before submitting a pull request.
## Contributing
Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request.
## License
This repository is licensed under the MIT License. See the LICENSE file for more information.