Coder Social home page Coder Social logo

cz-api's Introduction

Cuvantul Zilei REST API

PRs Welcome npm version Coverage Status

⚙️ RESTful API for api.cuvantulzilei.ro/

Demo

Features

  • No transpilers, just vanilla javascript
  • CORS enabled
  • Consistent coding styles with editorconfig
  • Gzip compression with compression
  • Linting with eslint
  • Continuous integration support with Netlify
  • todo: API documentation generation with apidoc
  • todo: Monitoring with pm2

Requirements

Getting Started

Clone the repo:

git clone https://github.com/Cuvantul-Zilei/cz-api.git
cd cz-api

Install dependencies:

npm install

Set environment variables (optional)

cp .env.example .env

Running Locally

npm run dev

Documentation (todo)

# generate and open api documentation
yarn docs

Deploy

Deployments are automatically synced with branch prod

Inspiration

License

MIT License

cz-api's People

Contributors

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