Giter VIP home page Giter VIP logo

free-ocean's Introduction

free-ocean

General Information

This is the back-end of a project made for the Hackaton "Hack The Ocean"

front-end repo is this

Free Ocean proposal to reach the communities, where will be able to participate against pollution ocean, the idea is to have a social impact to promote the care of the oceans.

Web page

Technologies

Status

This project is a BETA in development

Installation

To use this project you need to have Node and NPM installed.
After cloning, run the following commands in the terminal from the project folder:

npm install --save-dev [email protected]
npm install eslint --save-dev
npm install uuid
npm install express
npm install cors

Project structure

Project Diagram

graph
  JSON --> JSON_HANDLER
  JSON_HANDLER --> MEETINGS_CONTROLLER
  MEETING --> MEETINGS_CONTROLLER
  MEETING --> WEB_PAGE
  MEETINGS_CONTROLLER --> WEB_PAGE
Loading

Class Diagram

classDiagram
    Meeting --> FrontEnd
    MeetingsController --> FrontEnd
    JsonHandler --> MeetingsController
    class Meeting{
      string id
      string name
      string organizer
      string description
      string[] tags
      date startDate
      date endDate
      string location
      number followers
      bool isActive
      addFollower()
      removeFollower()
      addTag(tag)
      removeTag(tag)
    }
    class MeetingsController{
      getAll() Meeting[]
      getMeeting(id) Meeting
      filterMeetings(predicate) Meetings[]
      addFollower(meetingId)
      removeFollower(meetingId)
      addTag(meetingId, tag)
      removeTag(meetingId, tag)
      addMeeting(meeting)
      updateMeeting(id, newMeeting)
      deleteMeeting(id)
    }
    class JsonHandler{
      read(filePath) any
      rewrite(filePath, data)
      write(filePath, data)
      update(filePath, id, newData)
      delete(filePath, id)
    }
Loading

API Endpoints

GET

https://freeoceanapi.azurewebsites.net/v1/meetings: gets a list of all the existing meetings

POST

https://freeoceanapi.azurewebsites.net/v1/name=:name&&org=org&&desc=description&&tags=[tags]: adds a new meeting with the indicated params

free-ocean's People

Contributors

oscar-cbrlc avatar emmanuelperezt avatar djacobosanta avatar

Stargazers

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