Skip to content

Cuvantul-Zilei/cz-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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