Giter Club home page Giter Club logo

rest-api-exercise's Introduction

Title: List of Ultimate Songs of All Time

Description: This was a school project and the exercise consisted of building a REST API that communicates with a JSON file of our own choice. My JSON file is a list of ultimatate songs of all time where every oject has a unique id, a title, artist and year.

MET REQUIREMENTS: x Projektet innehåller minst 4 st. endpoints (GET, POST, PUT & DELETE för en resurs): ------> CHECK x Samtliga endpoints skall kunna nås via en REST Client fil (.rest|.http): ------> CHECK x All data skall vara sparad i en JSON-fil: ------> CHECK x Datan i JSON-filen skall uppdateras då något läggs till, uppdateras eller tas bort: ------> CHECK x APIét ska svara med 404 om datan saknas.: ------> CHECK x Git & GitHub har använts: ------> CHECK x Projektmappen innehåller en README.md fil: ------> CHECK

Uppgiften lämnas in i tid! Krav för väl godkänt:

x Alla punkter för godkänt är uppfyllda : ------> CHECK x Ett klient-gränssnitt skall byggas för att anropa API:ets alla olika endpoints och presentera datan, redigeringsformulär skall fyllas i med befintlig information. : ------> CHECK x Ytterligare en GET endpoint skall läggas till där det går att hämta ett specifikt objekt: ------> CHECK

HOW TO GET STARTED:

  1. Clone repository to a folder on your pc.
  2. Open project inside Visual Studio Code.
  3. Open terminal and install modules from package.json. To install modules type 'npm install' inside terminal and press enter. If error, go to package.json and see dependencies. Install manually by writig 'npm i (module name here)' for each module.
  4. Start server by either typing 'nodemon server.js' inside terminal. If error, start the module by clicking the 'run' button found inside: 'EXPLORER > NPM SCRIPTS > {package.json} start nodemon server.js'.
  5. To testrun the API use 'songs.rest'. Inside, use endpoints to: get data, get specified data, post new data, edit data or delete data.
  6. To view through frontend either enter http://localhost:3000/songs inside your preferred choice of web browser or open with Live Server (if installed inside VS Code) 'index.html'.
  7. Navigate endpoints through frontend design.

rest-api-exercise's People

Contributors

heinanx 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.