Git Product home page Git Product logo

music-web-app's Introduction

Music Collection API And Web App

This project was developed as part of an assignment in Marmara University's BLM3062.1.0 Açık Kaynak Kodlu Yazılımlar (Open Source Software) class. The server handles:

  • adding tracks
  • modifying tracks by id
  • deleting tracks by id
  • listing all tracks together and by id

The project has been implemented as a collection of networking docker containers using docker compose. Here is a list of the containers and the services they provide:

  1. music-web-app: Runs the server code and interfaces with the database to retrieve and store information.
  2. music-postgres: Runs an instance of postgres.
  3. swagger-ui: Provides a convenient UI for viewing the API endpoints and testing them.

The REST API has been documented in OpenAPI format and the openapi.yaml file is included in the doc folder.

Setup And Use

Docker and docker compose installed and set up into your system in order to work with this project. Then you need to fork the repository and cd into it.

This command builds the docker image, runs it and starts all the services:

foo@bar:~$ docker compose up --build

This command terminates all services and the network:

foo@bar:~$ docker compose down

To visualize the API and test it you can use SwaggerUI which is included as a docker container and can be accessed from the following address:

http://localhost:81

The server itself can be interfaced with directly by directing your browser to:

http://localhost:3000

Ports

The ports that the containers are left open to access from are given below.

container_name host container
music-web-app 3000 3000
music-postgres 8001 5432
swagger-ui 81 8080

music-web-app's People

Contributors

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