Giter VIP home page Giter VIP logo

starducks-server's Introduction

CircleCI

☕️ Starducks Server

Description

  • This repository is created with Express JS, to develop a REST API for CRUD processes of coffee data given by company. Because of the given YAML file, Swagger UI preferred for documentation. Deployment process done on Heroku and CI/CD pipelines managed by using CircleCI.

Dependencies

  • Cors: Used to enable CORS policy
  • Morgan: Used as a logger
  • MongoDB: Used as database
  • Mongoose: Used for object modeling
  • Nodemon: Used to restart server automatically
  • Swagger UI Express: Used to serve Swagger
  • Swagger JSDoc: Used to read annotated source code and generate OpenAPI specs.
  • UUID: Used to generate random UUIDs

Installation

# install packages
yarn

#start application with node
yarn start

# start application with nodemon to see changes on server instantly
yarn dev

# test application
yarn test

starducks-server's People

Contributors

damla avatar

Stargazers

avatar

Watchers

avatar

starducks-server's Issues

Deploy

To-Dos

  • Deploy to Heroku
  • Set CircleCI

🧾 Backlog 🧾

Specs

Back-end

  • Expose the endpoint as a Restful HTTP service consuming and returning a JSON
    response as per the api spec (coffees-openapi.yaml).

Tasks

Testing

  • There are missing test cases.

Initialize Server

To-Dos

  • Initialize project with the required dependencies.
    • cors
    • express
    • lowed
    • morgan
    • nodemon
    • swagger-jsdoc
    • swagger-ui-express
    • uuid
    • chai
    • chai-http
    • mocha
  • #5

Create Endpoints

To-Dos

  • GET /coffee-list

  • POST /coffee-list

  • GET /coffee/{id}

  • DELETE /coffee/{id}

  • PUT /coffee/{id}

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.