Giter Club home page Giter Club logo

note-app-api's Introduction

Notatnik API

Notatnik API to prosty serwer REST API, który pozwala na tworzenie, odczytywanie, aktualizowanie i usuwanie notatek. Projekt został stworzony w Node.js z wykorzystaniem frameworka Express oraz bazy danych PostgreSQL.

PostgreSQL URI in db.js

I have intentionally placed the Secret type: PostgreSQL URI in the db.js file to allow anyone to easily use and clone this project. This decision was made to simplify the setup process and allow for greater accessibility.

Please note: Although this approach makes it easier to get started with the project, it may have potential security risks. Make sure you understand the implications of exposing sensitive information like connection strings in your project files, and consider implementing proper security measures when deploying the project to a production environment.

Funkcjonalności

  • Dodawanie nowych notatek
  • Pobieranie wszystkich notatek
  • Pobieranie notatki o danym id
  • Aktualizacja notatki o danym id
  • Usuwanie notatki o danym id

Wymagania

  • Node.js (wersja 12 lub nowsza)
  • npm (wersja 6 lub nowsza)
  • PostgreSQL

Instalacja

  1. Sklonuj repozytorium:
git clone https://github.com/petitoff/note-app-api.git
  1. Zainstaluj wymagane zależności:
cd note-app-api
npm install
  1. Skonfiguruj połączenie z bazą danych PostgreSQL:

Edytuj plik db.js i uzupełnij właściwy connection string.

  1. Uruchom serwer:
npm start

Użycie

Serwer uruchomi się na porcie 3000 (domyślnie) i będzie dostępny pod adresem http://localhost:3000. Aby korzystać z API, możesz użyć następujących ścieżek i metod HTTP:

  • POST /api/notes - dodaj notatkę
  • GET /api/notes - pobierz wszystkie notatki
  • GET /api/notes/:id - pobierz notatkę o danym id
  • PUT /api/notes/:id - aktualizuj notatkę o danym id
  • DELETE /api/notes/:id - usuń notatkę o danym id

Współpraca

Jeśli chcesz współpracować nad projektem lub zgłosić błąd, proszę utwórz issue w repozytorium GitHub lub skontaktuj się z autorem.

Licencja

Ten projekt jest udostępniany na podstawie licencji MIT.

note-app-api's People

Contributors

petitoff avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.