Skip to content

israelhp/api-notes

Repository files navigation

API-NOTES

GitHub License GitHub Repo stars GitHub forks GitHub commit activity

🛠️ Stack

Key Features

  • Create new notes
  • Retrieve all notes
  • Retrieve a specific note by ID
  • Update an existing note
  • Delete a note

🚀 Getting Started

  1. Clone this repository.
  2. Run npm install to install dependencies.
  3. Configure the connection to your MongoDB database in the .env file.
  4. Run npm start to start the server.

Usage

  • Access the API through http://localhost:3000/api-notes.
  • Use tools like Postman or cURL to interact with the API endpoints.

🛠️ Project Structure

/src
|-- /app
|   |-- /controllers
|   |   |-- noteController.js
|   |
|   |-- /services
|       |-- noteService.js
|
|-- /config
|   |-- db.js
|
|-- /core
|   |-- /entities
|   |   |-- noteEntity.js
|   |
|   |-- /repositories
|       |-- noteRepository.js
|
|-- /interfaces
|   |-- /api
|   |   |-- expressRouter.js
|   |
|   |-- /middlewares
|   |   |-- expressRouter.js
|
|-- /utils
|   |-- helpers.js
|
|-- index.js
|-- server.js

Diagram

Diagrama

🔑 License

This project is under the MIT License - see the LICENSE file for more details.

🧞 Commands

Command Action
⚙️ dev or start Starts local dev server at localhost:3000.

Contact

You can reach me at [israelhurtarte@gmail.com].

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published